@honua/sdk-js
    Preparing search index...

    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;
    }
    Index

    Properties

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

    Properties

    basePath?: string

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

    capabilityPolicy?: "advertised" | "strict"

    See HonuaOgcProcessesOptions.capabilityPolicy.

    client: HonuaClient
    conformance?: HonuaOgcProcessesConformanceInput

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

    initialStatus?: HonuaOgcProcessJobStatus

    Initial server snapshot, as returned from executeOgcProcess.

    jobControlOptions?: readonly string[]

    The originating process's advertised jobControlOptions, when known.

    jobId: string
    pollBudget?: JobResultsOptions

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

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

    Override of the default polling behavior; useful in tests.

    pollIntervalMs?: number

    Default pollIntervalMs for results().

    processId?: string

    Process identifier the job was created from, when known.

    resultsPath?: string

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

    statusPath?: string

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

    Settings

    Member Visibility

    On This Page

    Properties