Class IdsHost

Host information for install.determinate.systems.

Index

Constructors

Methods

getDiagnosticsUrl getDynamicRootUrl getGot getRootUrl isUrlSubjectToDynamicUrls markCurrentHostBroken setPrioritizedUrls

Constructors

constructor

new IdsHost(
    idsProjectName: string,
    diagnosticsSuffix: string | undefined,
    runtimeDiagnosticsUrl: string | undefined,
    timeout?: number,
): IdsHost
Parameters
- idsProjectName: string
- diagnosticsSuffix: string | undefined
- runtimeDiagnosticsUrl: string | undefined
- timeout: number = DEFAULT_TIMEOUT
Returns IdsHost
- Defined in ids-host.ts:34

Methods

getDiagnosticsUrl

getDiagnosticsUrl(): Promise<URL | undefined>
The diagnostics endpoint of the current backend.

This library reports nothing there: its telemetry is OpenTelemetry. The URL is for the programs an Action runs, which have diagnostics of their own.

Returns Promise<URL | undefined>
- Defined in ids-host.ts:185

getDynamicRootUrl

getDynamicRootUrl(): Promise<URL | undefined>
Returns Promise<URL | undefined>
- Defined in ids-host.ts:137

getGot

getGot(
    recordFailoverCallback?: (
        incitingError: unknown,
        prevUrl: URL,
        nextUrl: URL,
    ) => void,
): Promise<Got>
Parameters
- OptionalrecordFailoverCallback: (incitingError: unknown, prevUrl: URL, nextUrl: URL) => void
Returns Promise<Got>
- Defined in ids-host.ts:47

getRootUrl

getRootUrl(): Promise<URL>
Returns Promise<URL>
- Defined in ids-host.ts:168

isUrlSubjectToDynamicUrls

isUrlSubjectToDynamicUrls(url: URL): boolean
Parameters
- url: URL
Returns boolean
- Defined in ids-host.ts:123

markCurrentHostBroken

markCurrentHostBroken(): void
Returns void
- Defined in ids-host.ts:115

setPrioritizedUrls

setPrioritizedUrls(urls: URL[]): void
Parameters
- urls: URL[]
Returns void
- Defined in ids-host.ts:119