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

    Interface Plane

    The operations every executor has.

    Anything a particular executor cannot do is absent from here and reached through a capability instead, so this interface stays the set of things that work everywhere.

    interface Plane {
        capabilities: PlaneCapabilities;
        credentialKey: string;
        http: HttpClient;
        kind: "cloudflare" | "dispatch" | "workerd";
        target: string;
        content(name: string): Promise<Response>;
        delete(name: string): Promise<void>;
        deleteSecret(name: string, secretName: string): Promise<void>;
        exists(name: string): Promise<boolean>;
        get(name: string): Promise<WorkerSummary | null>;
        list(options?: { limit?: number }): Promise<WorkerSummary[]>;
        listSecrets(name: string): Promise<SecretSummary[]>;
        patchSettings(
            name: string,
            settings: Partial<WorkerSettings>,
        ): Promise<WorkerSettings>;
        putSecret(
            name: string,
            secret: { name: string; text: string },
        ): Promise<void>;
        setTags(name: string, tags: string[]): Promise<string[]>;
        settings(name: string): Promise<WorkerSettings>;
        upload(name: string, upload: BuiltUpload): Promise<UploadResult>;
    }

    Implemented by

    Index
    capabilities credentialKey http kind target
    content delete deleteSecret exists get list listSecrets patchSettings putSecret setTags settings upload
    capabilities: PlaneCapabilities
    credentialKey: string

    the credential this plane spends against, so a hub can share one budget across planes

    http: HttpClient
    kind: "cloudflare" | "dispatch" | "workerd"
    target: string

    what this plane is, for an error message: an account id, a namespace, an endpoint

    content

    • content(name: string): Promise<Response>

      the deployed modules, where the plane can return them

      Parameters

      • name: string

      Returns Promise<Response>

    • Parameters

      • name: string
      • secretName: string

      Returns Promise<void>

    • Parameters

      • name: string
      • secret: { name: string; text: string }

      Returns Promise<void>

    • Parameters

      • name: string
      • tags: string[]

      Returns Promise<string[]>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods