https://github.com/cakedan/cf-worker-router
Cloudflare Worker Router
https://github.com/cakedan/cf-worker-router
Last synced: 8 months ago
JSON representation
Cloudflare Worker Router
- Host: GitHub
- URL: https://github.com/cakedan/cf-worker-router
- Owner: cakedan
- License: mit
- Created: 2019-01-30T06:17:30.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-09-22T06:43:56.000Z (over 6 years ago)
- Last Synced: 2025-04-13T01:18:05.374Z (9 months ago)
- Language: TypeScript
- Size: 28.3 KB
- Stars: 22
- Watchers: 0
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - cf-worker-router
README
# Cloudflare Worker Router
easier cloudflare request routing
## Example Usage
```js
import { ApiError, ApiRedirect, DomainRouter, FetchRouter } from 'cf-worker-router';
const router = new FetchRouter();
// add the cloudflare event listener
addEventListener('fetch', (event) => {
router.onFetch(event);
});
// after every response, modify it (like setting CORS headers)
// is optional
router.beforeResponse = (response, event) => {
// create a new Response instance, incase it's immutable like from a fetch request
response = new Response(response.body, response);
response.headers.set('access-control-allow-headers', 'Content-Type, X-Some-Header');
response.headers.set('access-control-allow-methods', '*');
response.headers.set('access-control-allow-origin', event.url.origin || '*');
return response;
};
// same as .route(url, 'GET', handler);
// GET */users/1234
router.route('/users/:userId', async (event) => {
// automatically converts anything not of Response type to ApiResponse
return event.parameters;
});
// same as .route(url, ['GET', 'POST', 'PUT', 'DELETE', 'HEAD', 'OPTIONS'], handler)
// ANY-METHOD */proxy/:url
router.route('/proxy/:url', '*', async (event) => {
if (event.request.headers.get('secret-token') !== 'test') {
return new ApiError({status: 403});
}
// remove our ip from headers
event.request.headers.delete('cf-connecting-ip');
event.request.headers.delete('x-real-ip');
return await fetch(event.parameters.url, event.request);
});
// GET redirect.example.com/:url
router.route('redirect.example.com/:url', async (event) => {
return new ApiRedirect(event.parameters.url);
});
// GET example.com/string-test/anystringhere
// GET example.com/string-test/anystringhere/andanythingwithslashes
router.route('example.com/string-test/:string...', async (event) => {
return event.parameters;
});
// GET example.club/pass
// passes it onto original destination, doesn't call `event.respondWith()`
router.route('example.com/pass', {pass: true});
const subDomain = new DomainRouter(':username.example.com');
router.addRouter(subDomain);
// GET some-username.example.com/files/1234
subDomain.get('/files/:fileId', async (event) => {
// {username, fileId} are the parameters
return event.parameters;
});
```
## Example Usage w/ Minified Version
```js
// Copy and Paste ./min/router.min.js at the top of the file
// !function(e){...
// We put our library in self.CFWorkerRouter
const { ApiError, ApiRedirect, DomainRouter, FetchRouter } = CFWorkerRouter;
const router = new FetchRouter();
// add the cloudflare event listener
addEventListener('fetch', (event) => {
router.onFetch(event);
});
// after every response, modify it (like setting CORS headers)
// is optional
router.beforeResponse = (response, event) => {
// create a new Response instance, incase it's immutable like from a fetch request
response = new Response(response.body, response);
response.headers.set('access-control-allow-headers', 'Content-Type, X-Some-Header');
response.headers.set('access-control-allow-methods', '*');
response.headers.set('access-control-allow-origin', event.url.origin || '*');
return response;
};
// same as .route(url, 'GET', handler);
// GET */users/1234
router.route('/users/:userId', async (event) => {
// automatically converts anything not of Response type to ApiResponse
return event.parameters;
});
// same as .route(url, ['GET', 'POST', 'PUT', 'DELETE', 'HEAD', 'OPTIONS'], handler)
// ANY-METHOD */proxy/:url
router.route('/proxy/:url', '*', async (event) => {
if (event.request.headers.get('secret-token') !== 'test') {
return new ApiError({status: 403});
}
// remove our ip from headers
event.request.headers.delete('cf-connecting-ip');
event.request.headers.delete('x-real-ip');
return await fetch(event.parameters.url, event.request);
});
// GET redirect.example.com/:url
router.route('redirect.example.com/:url', async (event) => {
return new ApiRedirect(event.parameters.url);
});
// GET example.com/string-test/anystringhere
// GET example.com/string-test/anystringhere/andanythingwithslashes
router.route('example.com/string-test/:string...', async (event) => {
return event.parameters;
});
// GET example.club/pass
// passes it onto original destination, doesn't call `event.respondWith()`
router.route('example.com/pass', {pass: true});
const subDomain = new DomainRouter(':username.example.com');
router.addRouter(subDomain);
// GET some-username.example.com/files/1234
subDomain.get('/files/:fileId', async (event) => {
// {username, fileId} are the parameters
return event.parameters;
});
```