cloudflare/resources/workers/workers.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../resource.js";
import * as AccountSettingsAPI from "./account-settings.js";
import { AccountSettingGetParams, AccountSettingGetResponse, AccountSettingUpdateParams, AccountSettingUpdateResponse, AccountSettings } from "./account-settings.js";
import * as DomainsAPI from "./domains.js";
import { Domain, DomainDeleteParams, DomainGetParams, DomainListParams, DomainUpdateParams, Domains, DomainsSinglePage } from "./domains.js";
import * as RoutesAPI from "./routes.js";
import { RouteCreateParams, RouteCreateResponse, RouteDeleteParams, RouteDeleteResponse, RouteGetParams, RouteGetResponse, RouteListParams, RouteListResponse, RouteListResponsesSinglePage, RouteUpdateParams, RouteUpdateResponse, Routes } from "./routes.js";
import * as SubdomainsAPI from "./subdomains.js";
import { SubdomainGetParams, SubdomainGetResponse, SubdomainUpdateParams, SubdomainUpdateResponse, Subdomains } from "./subdomains.js";
import * as AssetsAPI from "./assets/assets.js";
import { Assets } from "./assets/assets.js";
import * as BetaAPI from "./beta/beta.js";
import { Beta } from "./beta/beta.js";
import * as ObservabilityAPI from "./observability/observability.js";
import { Observability } from "./observability/observability.js";
import * as ScriptsAPI from "./scripts/scripts.js";
import { Script, ScriptDeleteParams, ScriptDeleteResponse, ScriptGetParams, ScriptGetResponse, ScriptListParams, ScriptSearchParams, ScriptSearchResponse, ScriptSetting, ScriptUpdateParams, ScriptUpdateResponse, Scripts, ScriptsSinglePage } from "./scripts/scripts.js";
export declare class Workers extends APIResource {
    beta: BetaAPI.Beta;
    routes: RoutesAPI.Routes;
    assets: AssetsAPI.Assets;
    scripts: ScriptsAPI.Scripts;
    accountSettings: AccountSettingsAPI.AccountSettings;
    domains: DomainsAPI.Domains;
    subdomains: SubdomainsAPI.Subdomains;
    observability: ObservabilityAPI.Observability;
}
export interface MigrationStep {
}
export interface MigrationStepParam {
    /**
     * A list of classes to delete Durable Object namespaces from.
     */
    deleted_classes?: Array<string>;
    /**
     * A list of classes to create Durable Object namespaces from.
     */
    new_classes?: Array<string>;
    /**
     * A list of classes to create Durable Object namespaces with SQLite from.
     */
    new_sqlite_classes?: Array<string>;
    /**
     * A list of classes with Durable Object namespaces that were renamed.
     */
    renamed_classes?: Array<MigrationStepParam.RenamedClass>;
    /**
     * A list of transfers for Durable Object namespaces from a different Worker and
     * class to a class defined in this Worker.
     */
    transferred_classes?: Array<MigrationStepParam.TransferredClass>;
}
export declare namespace MigrationStepParam {
    interface RenamedClass {
        from?: string;
        to?: string;
    }
    interface TransferredClass {
        from?: string;
        from_script?: string;
        to?: string;
    }
}
/**
 * A single set of migrations to apply.
 */
export interface SingleStepMigration {
}
/**
 * A single set of migrations to apply.
 */
export interface SingleStepMigrationParam {
    /**
     * A list of classes to delete Durable Object namespaces from.
     */
    deleted_classes?: Array<string>;
    /**
     * A list of classes to create Durable Object namespaces from.
     */
    new_classes?: Array<string>;
    /**
     * A list of classes to create Durable Object namespaces with SQLite from.
     */
    new_sqlite_classes?: Array<string>;
    /**
     * Tag to set as the latest migration tag.
     */
    new_tag?: string;
    /**
     * Tag used to verify against the latest migration tag for this Worker. If they
     * don't match, the upload is rejected.
     */
    old_tag?: string;
    /**
     * A list of classes with Durable Object namespaces that were renamed.
     */
    renamed_classes?: Array<SingleStepMigrationParam.RenamedClass>;
    /**
     * A list of transfers for Durable Object namespaces from a different Worker and
     * class to a class defined in this Worker.
     */
    transferred_classes?: Array<SingleStepMigrationParam.TransferredClass>;
}
export declare namespace SingleStepMigrationParam {
    interface RenamedClass {
        from?: string;
        to?: string;
    }
    interface TransferredClass {
        from?: string;
        from_script?: string;
        to?: string;
    }
}
/**
 * JSON-encoded metadata about the uploaded parts and Worker configuration.
 */
export interface WorkerMetadata {
    /**
     * Name of the part in the multipart request that contains the script (e.g. the
     * file adding a listener to the `fetch` event). Indicates a
     * `service worker syntax` Worker.
     */
    body_part?: string;
    /**
     * Name of the part in the multipart request that contains the main module (e.g.
     * the file exporting a `fetch` handler). Indicates a `module syntax` Worker.
     */
    main_module?: string;
}
/**
 * JSON-encoded metadata about the uploaded parts and Worker configuration.
 */
export interface WorkerMetadataParam {
    /**
     * Name of the part in the multipart request that contains the script (e.g. the
     * file adding a listener to the `fetch` event). Indicates a
     * `service worker syntax` Worker.
     */
    body_part?: string;
    /**
     * Name of the part in the multipart request that contains the main module (e.g.
     * the file exporting a `fetch` handler). Indicates a `module syntax` Worker.
     */
    main_module?: string;
}
export declare namespace Workers {
    export { type MigrationStep as MigrationStep, type SingleStepMigration as SingleStepMigration, type WorkerMetadata as WorkerMetadata, };
    export { Beta as Beta };
    export { Routes as Routes, type RouteCreateResponse as RouteCreateResponse, type RouteUpdateResponse as RouteUpdateResponse, type RouteListResponse as RouteListResponse, type RouteDeleteResponse as RouteDeleteResponse, type RouteGetResponse as RouteGetResponse, RouteListResponsesSinglePage as RouteListResponsesSinglePage, type RouteCreateParams as RouteCreateParams, type RouteUpdateParams as RouteUpdateParams, type RouteListParams as RouteListParams, type RouteDeleteParams as RouteDeleteParams, type RouteGetParams as RouteGetParams, };
    export { Assets as Assets };
    export { Scripts as Scripts, type Script as Script, type ScriptSetting as ScriptSetting, type ScriptUpdateResponse as ScriptUpdateResponse, type ScriptDeleteResponse as ScriptDeleteResponse, type ScriptGetResponse as ScriptGetResponse, type ScriptSearchResponse as ScriptSearchResponse, ScriptsSinglePage as ScriptsSinglePage, type ScriptUpdateParams as ScriptUpdateParams, type ScriptListParams as ScriptListParams, type ScriptDeleteParams as ScriptDeleteParams, type ScriptGetParams as ScriptGetParams, type ScriptSearchParams as ScriptSearchParams, };
    export { AccountSettings as AccountSettings, type AccountSettingUpdateResponse as AccountSettingUpdateResponse, type AccountSettingGetResponse as AccountSettingGetResponse, type AccountSettingUpdateParams as AccountSettingUpdateParams, type AccountSettingGetParams as AccountSettingGetParams, };
    export { Domains as Domains, type Domain as Domain, DomainsSinglePage as DomainsSinglePage, type DomainUpdateParams as DomainUpdateParams, type DomainListParams as DomainListParams, type DomainDeleteParams as DomainDeleteParams, type DomainGetParams as DomainGetParams, };
    export { Subdomains as Subdomains, type SubdomainUpdateResponse as SubdomainUpdateResponse, type SubdomainGetResponse as SubdomainGetResponse, type SubdomainUpdateParams as SubdomainUpdateParams, type SubdomainGetParams as SubdomainGetParams, };
    export { Observability as Observability };
}
//# sourceMappingURL=workers.d.ts.map