cloudflare
Version:
The official TypeScript library for the Cloudflare API
104 lines • 3.7 kB
TypeScript
import { APIResource } from "../../../../../core/resource.js";
import * as WorkersAPI from "../../../../workers/workers.js";
import * as ScriptsAPI from "../../../../workers/scripts/scripts.js";
import { APIPromise } from "../../../../../core/api-promise.js";
import { type Uploadable } from "../../../../../core/uploads.js";
import { RequestOptions } from "../../../../../internal/request-options.js";
export declare class BaseContent extends APIResource {
static readonly _key: readonly [
'workersForPlatforms',
'dispatch',
'namespaces',
'scripts',
'content'
];
/**
* Replace content for a script uploaded to a Workers for Platforms dispatch
* namespace.
*
* @example
* ```ts
* const script =
* await client.workersForPlatforms.dispatch.namespaces.scripts.content.update(
* 'this-is_my_script-01',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* dispatch_namespace: 'my-dispatch-namespace',
* metadata: {},
* },
* );
* ```
*/
update(scriptName: string, params: ContentUpdateParams, options?: RequestOptions): APIPromise<ScriptsAPI.Script>;
/**
* Fetch content from a script uploaded to a Workers for Platforms dispatch
* namespace.
*
* @example
* ```ts
* const content =
* await client.workersForPlatforms.dispatch.namespaces.scripts.content.get(
* 'this-is_my_script-01',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* dispatch_namespace: 'my-dispatch-namespace',
* },
* );
*
* const data = await content.blob();
* console.log(data);
* ```
*/
get(scriptName: string, params: ContentGetParams, options?: RequestOptions): APIPromise<Response>;
}
export declare class Content extends BaseContent {
}
export interface ContentUpdateParams {
/**
* Path param: Identifier.
*/
account_id: string;
/**
* Path param: Name of the Workers for Platforms dispatch namespace.
*/
dispatch_namespace: string;
/**
* Body param: JSON-encoded metadata about the uploaded parts and Worker
* configuration.
*/
metadata: WorkersAPI.WorkerMetadataParam;
/**
* Body param: An array of modules (often JavaScript files) comprising a Worker
* script. At least one module must be present and referenced in the metadata as
* `main_module` or `body_part` by filename.<br/>Possible Content-Type(s) are:
* `application/javascript+module`, `text/javascript+module`,
* `application/javascript`, `text/javascript`, `text/x-python`,
* `text/x-python-requirement`, `application/wasm`, `text/plain`,
* `application/octet-stream`, `application/source-map`.
*/
files?: Array<Uploadable>;
/**
* Header param: The multipart name of a script upload part containing script
* content in service worker format. Alternative to including in a metadata part.
*/
'CF-WORKER-BODY-PART'?: string;
/**
* Header param: The multipart name of a script upload part containing script
* content in es module format. Alternative to including in a metadata part.
*/
'CF-WORKER-MAIN-MODULE-PART'?: string;
}
export interface ContentGetParams {
/**
* Identifier.
*/
account_id: string;
/**
* Name of the Workers for Platforms dispatch namespace.
*/
dispatch_namespace: string;
}
export declare namespace Content {
export { type ContentUpdateParams as ContentUpdateParams, type ContentGetParams as ContentGetParams };
}
//# sourceMappingURL=content.d.ts.map