https://github.com/jspies/cloudflare-workers-toolkit

Simple SDK wrapper for resources useful in Cloudflare Workers
https://github.com/jspies/cloudflare-workers-toolkit

Last synced: 27 days ago
JSON representation

Simple SDK wrapper for resources useful in Cloudflare Workers

• Host: GitHub
• URL: https://github.com/jspies/cloudflare-workers-toolkit
• Owner: jspies
• Created: 2018-11-28T20:08:46.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-06-24T21:00:11.000Z (over 2 years ago)
• Last Synced: 2024-08-09T18:34:46.532Z (4 months ago)
• Language: JavaScript
• Size: 86.9 KB
• Stars: 6
• Watchers: 5
• Forks: 4
• Open Issues: 6
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# Cloudflare Workers Toolkit

This library provides a simple integration to Cloudflare's APIs for resources applicable to [Cloudflare Workers](https://developers.cloudflare.com/workers/about/).

### Multiscript versus Single Script

There are some subtle and not so subtle differences between Cloudflare accounts with multiscript enabled or not. By default, a standard Cloudflare account has single script enabled and an enterprise account has multi script enabled.

The subtle difference has to do with whether you deploy scripts by account or zone. The worker scripts take either an accountId (multi script) or zoneId (single script). When using an accountId, you must also specify a name for the script. You do not need to name a single script (zoneId) worker.

The not so subtle difference is that single script accounts use filters and multi script accounts use routes. Routes and Filters both use a URL pattern to control worker behavior. The difference is that filters control whether the single worker runs or doesn't run, whereas routes control which worker script is run.

### Installation

```

npm install cloudflare-workers-toolkit

```

### Initialize

```

const cloudflare = require("cloudflare-workers-toolkit");

cloudflare.setAccountId(accountId); // helper that sets an ENV var

cloudflare.setZoneId(zoneId);

```

### Workers

Deploy a worker (will overwrite as well as create)

```

cloudflare.workers.deploy({

  accountId,

  name: "My Worker",

  script: "addEventListener('fetch', event => {

      event.respondWith(new Response(event.request));

    });",

  bindings: []

})

```

```

cloudflare.workers.getSettings()

```

### Routes

Get all routes for a zone

```

cloudflare.routes.getRoutes({zoneId})

```

Remove a route

```

cloudflare.routes.remove({zoneId, routeId})

```

### KV Storage Namespaces

```

cloudflare.storage.getNamespaces({accountId})

cloudflare.storage.createNamespace({accountId, name: "namespace name"})

cloudflare.storage.removeNamespace({accountId, namespaceId})

```

You can also pass `name` to remove. This method will look the id up for you before requesting the removal.

```

cloudflare.storage.removeNamespace({accountId, name: "my namespace name"})

```

### Credentials

Cloudflare worker toolkit requires the following environment variables to be set:

```

CLOUDFLARE_AUTH_EMAIL

CLOUDFLARE_AUTH_KEY

```

Methods optionally take needed additional parameters, such as accountId. However, the following environment variables will be used as a fallback if set.

```

CLOUDFLARE_ACCOUNT_ID

```