Skip to content
ʕ •́؈•̀) TypeScript template for Cloudflare Workers
TypeScript JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Remove worker directory Jul 31, 2019
.prettierrc Use prettier and update README Jul 31, 2019
package-lock.json Merge pull request #6 from GregBrimble/fix-source-map-loader-dependency Aug 8, 2019
package.json Merge pull request #6 from GregBrimble/fix-source-map-loader-dependency Aug 8, 2019
webpack.config.js Run prettier Jul 31, 2019

ʕ •́؈•̀) worker-typescript-template

A batteries included template for kick starting a TypeScript Cloudflare worker project.

🔋 Getting Started

This template is meant to be used with wrangler. If you are not already familiar with the tool, we recommend that you install the tool and configure it to work with your Cloudflare account.

To generate using wrangler, run this command:

wrangler generate my-ts-project

👩 💻 Developing

src/index.js calls the request handler in src/handler.ts, and will return the request method for the given request.

🧪 Testing

This template comes with mocha tests which simply test that the request handler can handle each request method. npm test will run your tests.

✏️ Formatting

This template uses prettier to format the project. To invoke, run npm run format.

👀 Previewing and Publishing

For information on how to preview and publish your worker, please see the wrangler README.

🤢 Issues

If you run into issues with this specific project, please feel free to file an issue here. If the problem is with wrangler, please file an issue here.

⚠️ Caveats

The service-worker-mock used by the tests is not a perfect representation of the Cloudflare Workers runtime. It is a general approximation. We recommend that you test with wrangler preview and in a staging environment to test things before deploying.

You can’t perform that action at this time.