Skip to content

docs: update Workers script upload example with new interface #2629

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 17, 2025
Merged

docs: update Workers script upload example with new interface #2629

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 53 additions & 35 deletions examples/workers/script-upload.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,39 @@
* Set these environment variables:
* - CLOUDFLARE_API_TOKEN
* - CLOUDFLARE_ACCOUNT_ID
*
* ### Workers for Platforms ###
*
* For uploading a User Worker to a dispatch namespace:
* https://developers.cloudflare.com/cloudflare-for-platforms/workers-for-platforms/
*
* Define a "dispatchNamespaceName" variable and change the entire "const script = " line to the following:
* "const script = await client.workersForPlatforms.dispatch.namespaces.scripts.update(dispatchNamespaceName, scriptName, {"
*/

import Cloudflare from 'cloudflare';
import { toFile } from 'cloudflare/index';

const apiToken = process.env['CLOUDFLARE_API_TOKEN'] ?? '';
if (!apiToken) {
throw new Error('Please set envar CLOUDFLARE_ACCOUNT_ID');
}

const accountID = process.env['CLOUDFLARE_ACCOUNT_ID'] ?? '';
if (!accountID) {
throw new Error('Please set envar CLOUDFLARE_API_TOKEN');
}

const client = new Cloudflare({
apiToken: process.env['CLOUDFLARE_API_TOKEN'] ?? '',
apiToken: apiToken,
});
const accountID = process.env['CLOUDFLARE_ACCOUNT_ID'] ?? '';

async function main() {
const scriptName = 'my-hello-world-script';
const scriptFileName = `${scriptName}.mjs`;

// Workers Scripts prefer Module Syntax
// https://blog.cloudflare.com/workers-javascript-modules/
const scriptContent = `
export default {
async fetch(request, env, ctx) {
Expand All @@ -29,41 +50,38 @@ async function main() {
};
`;

const script: Cloudflare.Workers.Scripts.ScriptUpdateResponse = await client.workers.scripts.update(
scriptName,
{
try {
// https://developers.cloudflare.com/api/resources/workers/subresources/scripts/methods/update/
const script = await client.workers.scripts.update(scriptName, {
account_id: accountID,
/*
* Add script content keyed by the filename
*/
// @ts-ignore
[scriptFileName]: new File([scriptContent], scriptFileName, {
type: 'application/javascript+module',
}),
// @ts-ignore
metadata: new File(
[
JSON.stringify({
// https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/
bindings: [
{
type: 'plain_text',
name: 'MESSAGE',
text: 'Hello World!',
},
],
main_module: scriptFileName,
}),
// https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/
metadata: {
main_module: scriptFileName,
bindings: [
{
type: 'plain_text',
name: 'MESSAGE',
text: 'Hello World!',
},
],
'metadata.json',
{
type: 'application/json',
},
),
},
);

console.log(script.id);
},
files: {
// Add main_module file
[scriptFileName]: await toFile(Buffer.from(scriptContent), scriptFileName, {
type: 'application/javascript+module',
}),
// Can add other files, such as more modules or source maps
// [sourceMapFileName]: await toFile(Buffer.from(sourceMapContent), sourceMapFileName, {
// type: 'application/source-map',
// }),
},
});
console.log('Script Upload success!');
console.log(JSON.stringify(script, null, 2));
} catch (error) {
console.error('Script Upload failure!');
console.error(error);
}
}

main();
Loading