Interface HonuaOgcProcessJobOptions

interface HonuaOgcProcessJobOptions {
    basePath?: string;
    capabilityPolicy?: "advertised" | "strict";
    client: HonuaClient;
    conformance?: HonuaOgcProcessesConformanceInput;
    initialStatus?: HonuaOgcProcessJobStatus;
    jobControlOptions?: readonly string[];
    jobId: string;
    pollBudget?: JobResultsOptions;
    pollFn?: ((jobId: string, signal?: AbortSignal) => Promise<HonuaOgcProcessJobStatus>);
    pollIntervalMs?: number;
    processId?: string;
    resultsPath?: string;
    statusPath?: string;
}

Properties

basePath? capabilityPolicy? client conformance? initialStatus? jobControlOptions? jobId pollBudget? pollFn? pollIntervalMs? processId? resultsPath? statusPath?

Properties

OptionalbasePath

basePath?: string

Raw endpoint path prefix (defaults to the Honua facade /ogc/processes).

OptionalcapabilityPolicy

capabilityPolicy?: "advertised" | "strict"

See HonuaOgcProcessesOptions.capabilityPolicy.

client

client: HonuaClient

Optionalconformance

conformance?: HonuaOgcProcessesConformanceInput

Advertised conformance, used to gate cancel() on the Dismiss class.

OptionalinitialStatus

initialStatus?: HonuaOgcProcessJobStatus

Initial server snapshot, as returned from executeOgcProcess.

OptionaljobControlOptions

jobControlOptions?: readonly string[]

The originating process's advertised jobControlOptions, when known.

jobId

jobId: string

OptionalpollBudget

pollBudget?: JobResultsOptions

Default polling budget; per-call JobResultsOptions win field by field.

OptionalpollFn

pollFn?: ((jobId: string, signal?: AbortSignal) => Promise<HonuaOgcProcessJobStatus>)

Override of the default polling behavior; useful in tests.

OptionalpollIntervalMs

pollIntervalMs?: number

Default pollIntervalMs for results().

OptionalprocessId

processId?: string

Process identifier the job was created from, when known.

OptionalresultsPath

resultsPath?: string

Server-advertised results route (same-origin path), when the server published one.

OptionalstatusPath

statusPath?: string

Server-advertised status route (same-origin path), when the server published one.

Settings

Member Visibility

On This Page

Properties