@drupflare/workforce - v0.3.0
    Preparing search index...

    Class WorkerHandle

    Index
    constructor
    assets name plane secrets
    versions
    content delete deploy exists get patchSettings replaceBindings require rollback setTags settings tags upload
    assets: { sync: (tree: ModuleSet) => Promise<SyncResult> } = ...

    Type Declaration

    • sync: (tree: ModuleSet) => Promise<SyncResult>

      Uploads a whole asset tree; anything absent from it is deleted.

      There is deliberately no patch here. See assets.ts for why an incomplete manifest carries removed paths forward instead of deleting them.

    name: string
    plane: Plane
    secrets: {
        delete: (name: string) => Promise<void>;
        list: () => Promise<SecretSummary[]>;
        put: (
            name: string,
            text: string | Uint8Array<ArrayBufferLike>,
        ) => Promise<void>;
        putJson: (name: string, value: unknown) => Promise<void>;
    } = ...

    Type Declaration

    • delete: (name: string) => Promise<void>
    • list: () => Promise<SecretSummary[]>
    • put: (name: string, text: string | Uint8Array<ArrayBufferLike>) => Promise<void>
    • putJson: (name: string, value: unknown) => Promise<void>

      serialises for the caller, so nobody hand-rolls JSON.stringify at every call site

    • get versions(): VersionsApi

      Versions, deployments, rollback.

      Capability-gated: reaching for this on a plane without versions throws a named CapabilityError rather than producing a 404 the caller has to interpret.

      Returns VersionsApi

    content

    • convenience: deploy one version at 100 percent

      Parameters

      • version: string

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods