# cloudflare-worker-middleware

> Simple worker middleware in Typescript for cloudflare

Latest version **1.0.0** (published 2021-07-16) · MIT OR Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install cloudflare-worker-middleware
pnpm add cloudflare-worker-middleware
yarn add cloudflare-worker-middleware
bun add cloudflare-worker-middleware
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-07-16 |
| First published | 2021-07-16 |
| Weekly downloads | 0 |
| License | MIT OR Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 35.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | André Bauer |
| Maintainers | andre-bauer |
| Keywords | cloudflare, worker, middleware |

## Links

- npm: https://www.npmjs.com/package/cloudflare-worker-middleware
- Issues: https://github.com/AnBauer/cloudflare-worker-middleware/issues
- npm.io page: https://npm.io/package/cloudflare-worker-middleware

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2021-07-16

## README

# Cloudflare worker middleware 

A simple helper create awesome worker middlewares but only deploying ONE worker to cloudflare  

## 🔋 Getting Started

The easiest way to get started is using [Wrangler](https://github.com/cloudflare/wrangler) (Documentation can be found [here](https://developers.cloudflare.com/workers/tooling/wrangler/)).
Once you have wrangler, create your base for a worker middleware with this typescript template:
```bash
wrangler generate my-ts-worker-middleware https://github.com/cloudflare/worker-typescript-template
```
In the generated project, add the middleware helper:

```bash
npm i cloudflare-worker-middleware
```

### 👩 💻 Developing
To start adding routes and corresponding handlers to your middleware, go to your [`src/index.ts`](./src/index.ts) and 
import the provided functions:
```typescript
import {registerRoute, registerRouteNotFoundHandler, registerFetchEventListener} from 'cloudflare-worker-middleware';
```

#### Registering routes
```typescript
registerRoute(/awesome-test-route/, () => Promise.resolve(new Response('boom, baby!')));
```
Attention: `registerRoute` expects a regular expression, so make sure to be as precise as necessary and do NOT include the base path! 

#### Add a custom route not found handler
The assumption is, that a middleware has a base path like `api` or something like that so that the worker can be deployed
to cloudflare and registered for all routes that start with api: `api/*`. For all unhandled routes a 404 will be returned.
If you want a custom response, you can register it via 
```typescript
registerRouteNotFoundHandler(() => Promise.resolve(new Response('End of the internet', {status: 404})));
```

### Activation your middleware
In order to use your middleware, you need to let `cloudflare-worker-middleware` handle all requests for a specific base path
```Typescript
registerFetchEventListener('api')
```

---
_Source: https://npm.io/package/cloudflare-worker-middleware · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
