Interface CheckPortalsOptions

Options for checkPortalUrls and checkPortals.

interface CheckPortalsOptions {
    concurrency?: number;
    createClient?: (options: EngineOptions) => CkanClient;
    engineOptions?: EngineOptions;
    retryDelayMs?: number;
    sleep?: (ms: number) => Promise<void>;
}

Properties

concurrency?: number

Checks in flight at once, 1 or more. Defaults to DEFAULT_CHECK_CONCURRENCY (6).

createClient?: (options: EngineOptions) => CkanClient

Builds the client for one portal. Defaults to new CkanClient(options).

engineOptions?: EngineOptions

Client options for every check; baseUrl is replaced by each portal's URL.

retryDelayMs?: number

When set, a failed check is repeated once after this pause (ms), so one timeout does not count as down. Unset (the default): a single try.

sleep?: (ms: number) => Promise<void>

Injectable sleep for the retry pause, for tests.