Anchorage API reference
    Preparing search index...
    interface PlainWorkerRouteApi {
        assertR2BucketEmpty?(resource: ApplicationR2Binding): Promise<void>;
        attachCustomDomain(
            target: { hostname: string; service: string },
            fence: ExternalMutationFence,
        ): Promise<void>;
        batchDatabase(
            databaseId: string,
            statements: readonly { bindings?: readonly string[]; sql: string }[],
        ): Promise<void>;
        createR2Bucket?(
            resource: ApplicationR2Binding,
            fence: ExternalMutationFence,
        ): Promise<void>;
        deleteControlSecrets(
            scriptName: string,
            secretNames: readonly string[],
            fence: ExternalMutationFence,
        ): Promise<void>;
        deleteDatabase?(databaseId: string): Promise<void>;
        deleteR2Bucket?(
            resource: ApplicationR2Binding,
            fence: ExternalMutationFence,
        ): Promise<void>;
        detachCustomDomain(
            domainId: string,
            fence: ExternalMutationFence,
        ): Promise<void>;
        disableOrdinaryWorkerPublicAccess(
            scriptName: string,
            fence: ExternalMutationFence,
        ): Promise<void>;
        getDatabase?(databaseId: string): Promise<DatabaseReference | undefined>;
        getR2Bucket?(
            bucketName: string,
            jurisdiction: R2Jurisdiction,
        ): Promise<ApplicationR2BucketSnapshot | undefined>;
        inspectActiveWorkerRoute(
            scriptName: string,
        ): Promise<
            | Readonly<{ artifactVersion: string; specDigest: string | undefined }>
            | undefined,
        >;
        inspectOrdinaryWorkerFootprint(
            scriptName: string,
        ): Promise<
            {
                customDomains: readonly PlainWorkerCustomDomain[];
                previewUrlsEnabled?: boolean;
                scriptPresent: boolean;
                workersDevEnabled?: boolean;
                zoneRoutes: readonly WorkerZoneRoute[];
            },
        >;
        listCustomDomains(): Promise<readonly PlainWorkerCustomDomain[]>;
        listDurableObjectNamespaces(scriptName: string): Promise<readonly string[]>;
        listOrdinaryWorkerSecretNames(
            scriptName: string,
        ): Promise<readonly string[]>;
        listWorkerDatabaseAttachments(
            databaseId: string,
        ): Promise<
            readonly Readonly<
                {
                    dispatchNamespace?: string;
                    plane: "ordinary"
                    | "dispatch";
                    scriptName: string;
                },
            >[],
        >;
        listWorkerR2Attachments?(
            bucketName: string,
        ): Promise<
            readonly Readonly<
                {
                    dispatchNamespace?: string;
                    plane: "ordinary"
                    | "dispatch";
                    scriptName: string;
                },
            >[],
        >;
        queryDatabase(
            databaseId: string,
            sql: string,
            bindings?: readonly string[],
        ): Promise<readonly Readonly<Record<string, unknown>>[]>;
        withMutationFence<T>(
            fence: ExternalMutationFence,
            operation: () => Promise<T>,
        ): Promise<T>;
    }

    Implemented by

    Index

    Methods

    • Parameters

      • databaseId: string
      • statements: readonly { bindings?: readonly string[]; sql: string }[]

      Returns Promise<void>

    • The version currently taking all of an ordinary Worker's traffic, plus the fleet specification digest that version was built from.

      Narrower than the version read inspect() performs, deliberately: an attestation needs the routed version and one binding, and every provider call it makes is charged against the account-wide request window the rate coordinator fences. It also goes through the provider API rather than the wrangler CLI, which runs outside that coordinator entirely.

      Returns undefined when the script does not exist. Throws ActiveRouteAttestationError when it exists but no single version holds 100% of the traffic — that ambiguity is the refusal, not a tie to break.

      Parameters

      • scriptName: string

      Returns Promise<
          | Readonly<{ artifactVersion: string; specDigest: string | undefined }>
          | undefined,
      >

    • Parameters

      • scriptName: string

      Returns Promise<
          {
              customDomains: readonly PlainWorkerCustomDomain[];
              previewUrlsEnabled?: boolean;
              scriptPresent: boolean;
              workersDevEnabled?: boolean;
              zoneRoutes: readonly WorkerZoneRoute[];
          },
      >

    • Parameters

      • scriptName: string

      Returns Promise<readonly string[]>

    • Parameters

      • scriptName: string

      Returns Promise<readonly string[]>

    • Parameters

      • databaseId: string

      Returns Promise<
          readonly Readonly<
              {
                  dispatchNamespace?: string;
                  plane: "ordinary"
                  | "dispatch";
                  scriptName: string;
              },
          >[],
      >

    • Parameters

      • bucketName: string

      Returns Promise<
          readonly Readonly<
              {
                  dispatchNamespace?: string;
                  plane: "ordinary"
                  | "dispatch";
                  scriptName: string;
              },
          >[],
      >

    • Parameters

      • databaseId: string
      • sql: string
      • Optionalbindings: readonly string[]

      Returns Promise<readonly Readonly<Record<string, unknown>>[]>