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

    Interface CreateColumnarPatchOperationOptionsExperimental

    Options for the patch worker operation.

    interface CreateColumnarPatchOperationOptions {
        allowRebuild?: boolean;
        limits?: GeoArrowConversionLimits;
        patch:
            | ColumnarPatchV1
            | (
                (
                    batch: ColumnarBatchV1,
                    context: ColumnarWorkerOperationContext,
                ) => ColumnarPatchV1 | Promise<ColumnarPatchV1>
            );
        rebuild?: ColumnarPatchRebuildOptions;
        reportProgress?: (fraction: number, stage: string) => void;
        signal?: AbortSignal;
        telemetry?: ColumnarTelemetry;
        thresholds?: ColumnarPatchThresholds;
    }

    Hierarchy (View Summary)

    Index

    Properties

    allowRebuild? limits? patch rebuild? reportProgress? signal? telemetry? thresholds?

    Properties

    allowRebuild?: boolean

    When false, any condition that would rebuild is rejected with rebuild-required instead, so a renderer that cannot rebind stays in control of when the batch identity changes. Defaults to true.

    limits?: GeoArrowConversionLimits
    patch:
        | ColumnarPatchV1
        | (
            (
                batch: ColumnarBatchV1,
                context: ColumnarWorkerOperationContext,
            ) => ColumnarPatchV1 | Promise<ColumnarPatchV1>
        )

    The patch to apply, or a provider consulted once per request so one registered operation can drain a live stream.

    rebuild?: ColumnarPatchRebuildOptions
    reportProgress?: (fraction: number, stage: string) => void

    Monotonic progress in [0, 1] with a stage label.

    signal?: AbortSignal
    telemetry?: ColumnarTelemetry

    Optional observer. Off by default: no surface constructs one, and with no sink the observed path costs exactly what it costs without this module.

    thresholds?: ColumnarPatchThresholds

    Settings

    Member Visibility

    On This Page

    Properties