Generated using TypeDoc
Function deployment
- deployment(ID, Project, Header): Promise<{
created_on: Date;
id: string;
}[]> The function
+Deploymentmakes an asynchronous request to the Cloudflare API to retrieve deployment +information for a specific project.Parameters
- ID: string
The
+IDparameter is a string that represents the Cloudflare account ID. It is +used to identify the Cloudflare account for which the deployment is being made. - Project: string
The
+Projectparameter is a string that represents the project ID or +name. It is used to specify the project for which you want to retrieve the deployments. - Header: HeadersInit
The
+Headerparameter is an object that represents the headers to be +included in the HTTP request. It should be of typeHeadersInit, which is a type alias forHeaders | string[][] | Record<string, string>.
Returns Promise<{
created_on: Date;
id: string;
}[]>- ID: string
Generated using TypeDoc
Function project
- project(ID, Header): Promise<{
id: string;
name: string;
}[]> The function
+Projectmakes an asynchronous request to the Cloudflare API to fetch a +list of projects associated with a given account ID, using the provided headers.Parameters
- ID: string
The ID parameter is a string that represents the account ID for +the Cloudflare API. It is used to specify which account's projects you want to +retrieve.
+ - Header: HeadersInit
The
+Headerparameter is an object that represents the +headers to be included in the HTTP request. It should be of typeHeadersInit, which +is a type alias for an object that can be used to initialize aHeadersobject. The +headers can include information such as authentication tokens, content
Returns Promise<{
id: string;
name: string;
}[]>- ID: string
Generated using TypeDoc
Function response
- response(Message?, Status?): Promise<Response>
The function
+Responseis an asynchronous function that returns a response object with a JSON +stringified message and a specified status code.Parameters
OptionalMessage: unknownThe
+Messageparameter is the data that you want to send as a +response. It can be of any type, but it will be converted to a JSON string before being sent.OptionalStatus: numberThe
+Statusparameter is an optional parameter that specifies the HTTP status +code of the response. If no value is provided, it defaults to 200 (OK).
Returns Promise<Response>
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
@playform/delete - v0.0.1
♻️ DeleteDeployment
Delete stale Cloudflare Pages deployment.
https://developers.cloudflare.com/api/operations/pages-@playform/delete-deployment
Installation
npm install -g @playform/delete
+CLI Usage
DeleteDeployment -e example@account.com -i accountId -k accountKey
+++Note
+This will not delete your last running deployment.
+
Options
-V, --version output the version number
-e, --Email Account E-mail. < Email > Cloudflare
-i, --ID Account ID. < ID > Cloudflare
-k, --Key API key. < Key > Cloudflare
-h, --help display help for command
+Worker
You can also publish it as a worker:
+wrangler deploy
+Script
Source/Index.ts
await(await import("@playform/delete"))(Email, ID, Key);
+.env
Email="example@account.com"
+ID="accountId"
+Key="accountKey"
+Changelog
See CHANGELOG.md for a history of changes to this utility.
+Generated using TypeDoc
Generated using TypeDoc
Interface Interface
interface Interface {}
Generated using TypeDoc
Generated using TypeDoc
Module Delete
Index
Interfaces
Variables
Functions
delete
+
Generated using TypeDoc
Generated using TypeDoc
Module Function/Deployment
Index
Type Aliases
Type
+
Functions
Generated using TypeDoc
Generated using TypeDoc
Module Function/Response
Index
Functions
response
+
Generated using TypeDoc
Generated using TypeDoc
Module Response
Index
Interfaces
Generated using TypeDoc
Module Variable/Environment
Index
Variables
Functions
string
+
Generated using TypeDoc
Type alias Type
Type: {
Email: string;
ID: string;
Key: string;
}
Email: string;
ID: string;
Key: string;
}
Type declaration
Email: string
ID: string
Key: string
Generated using TypeDoc
Generated using TypeDoc
Type alias Type
Type: {
result: {
id: string;
name: string;
}[];
}
result: {
id: string;
name: string;
}[];
}
Type declaration
result: {
id: string;
name: string;
}[]biome-ignore lint/suspicious/noExplicitAny:
+
Generated using TypeDoc
Variable Environment
Environment: ZodObject<{
Email: ZodDefault<ZodOptional<ZodString>>;
ID: ZodDefault<ZodOptional<ZodString>>;
Key: ZodDefault<ZodOptional<ZodString>>;
}, "strip", ZodTypeAny, {
Email: string;
ID: string;
Key: string;
}, {
Email?: string;
ID?: string;
Key?: string;
}>
Email: ZodDefault<ZodOptional<ZodString>>;
ID: ZodDefault<ZodOptional<ZodString>>;
Key: ZodDefault<ZodOptional<ZodString>>;
}, "strip", ZodTypeAny, {
Email: string;
ID: string;
Key: string;
}, {
Email?: string;
ID?: string;
Key?: string;
}>
Type declaration
Email: ZodDefault<ZodOptional<ZodString>>
ID: ZodDefault<ZodOptional<ZodString>>
Key: ZodDefault<ZodOptional<ZodString>>
Type declaration
Email: string
ID: string
Key: string
Type declaration
OptionalEmail?: stringOptionalID?: stringOptionalKey?: string
Generated using TypeDoc
Variable delete
delete: Command
Generated using TypeDoc
Variable worker
worker: ExportedHandler<{
Email: string;
ID: string;
Key: string;
}, unknown, unknown>
Email: string;
ID: string;
Key: string;
}, unknown, unknown>
Type declaration
Email: string
ID: string
Key: string
Generated using TypeDoc
Variable environment
environment: ZodObject<{
Email: ZodDefault<ZodOptional<ZodString>>;
ID: ZodDefault<ZodOptional<ZodString>>;
Key: ZodDefault<ZodOptional<ZodString>>;
}, "strip", ZodTypeAny, {
Email: string;
ID: string;
Key: string;
}, {
Email?: string;
ID?: string;
Key?: string;
}>
Email: ZodDefault<ZodOptional<ZodString>>;
ID: ZodDefault<ZodOptional<ZodString>>;
Key: ZodDefault<ZodOptional<ZodString>>;
}, "strip", ZodTypeAny, {
Email: string;
ID: string;
Key: string;
}, {
Email?: string;
ID?: string;
Key?: string;
}>
Type declaration
Email: ZodDefault<ZodOptional<ZodString>>
ID: ZodDefault<ZodOptional<ZodString>>
Key: ZodDefault<ZodOptional<ZodString>>
Type declaration
Email: string
ID: string
Key: string
Type declaration
OptionalEmail?: stringOptionalID?: stringOptionalKey?: string
Generated using TypeDoc
@TODO: Find a way to use await in parameters
+