https://github.com/mozzius/worker-experimentation
https://github.com/mozzius/worker-experimentation
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mozzius/worker-experimentation
- Owner: mozzius
- License: apache-2.0
- Created: 2023-01-13T15:07:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-13T15:41:42.000Z (over 3 years ago)
- Last Synced: 2026-02-17T22:47:24.536Z (4 months ago)
- Language: TypeScript
- Size: 58.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE_APACHE
Awesome Lists containing this project
README
# ʕ •́؈•̀) `worker-typescript-template`
## ⚠️ Warning: This template is no longer maintained
Create TypeScript workers in the [command-line with Wrangler 2.0.0+](https://developers.cloudflare.com/workers/wrangler/get-started/) using `wrangler init` instead.
---
A batteries included, with the latest Wrangler, template for kick starting a TypeScript Cloudflare worker project.
## Note: You must use [wrangler](https://developers.cloudflare.com/workers/cli-wrangler/install-update) 1.17 or newer to use this template.
## 🔋 Getting Started
This template is meant to be used with [Wrangler](https://github.com/cloudflare/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](https://dash.cloudflare.com). Documentation can be found [here](https://developers.cloudflare.com/workers/tooling/wrangler/).
To generate using Wrangler, run this command:
```bash
wrangler generate my-ts-project https://github.com/cloudflare/worker-typescript-template
```
### 👩 💻 Developing
[`src/index.ts`](./src/index.ts) calls the request handler in [`src/handler.ts`](./src/handler.ts), and will return the [request method](https://developer.mozilla.org/en-US/docs/Web/API/Request/method) for the given request.
### 🧪 Testing
This template comes with jest tests utilizing [Miniflare](https://github.com/cloudflare/miniflare) which simply test that the request handler can handle each request method. `npm test` will run your tests.
### ✏️ Formatting
This template uses [`prettier`](https://prettier.io/) 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 docs](https://developers.cloudflare.com/workers/tooling/wrangler/commands/#publish).
## 🤢 Issues
If you run into issues with this specific project, please feel free to file an issue [here](https://github.com/cloudflare/worker-typescript-template/issues). If the problem is with Wrangler, please file an issue [here](https://github.com/cloudflare/wrangler/issues).