Skip to content

fix(docs): Fix WorkersRouter() #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(docs): Fix WorkersRouter() #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The goal of Worker Router is to *infer types based on usage* so that **no explic
This allows even JavaScript users to benefit from inline documentation and API discoverability. For example,

```js
const router = new WorkersRouter()
const router = new WorkerRouter()
.get('/about', basics(), (req, { userAgent }) => ok())
.get('/login', unsignedCookies(), (req, { cookies }) => ok())
```
Expand All @@ -32,7 +32,7 @@ const myReusableMW = combine(
cookieSession({ user: '' })
);

const router = new WorkersRouter()
const router = new WorkerRouter()
.get('/', myReusableMW, () => ok())
.post('/', combine(myReusableMW, bodyParser()), () => ok())
```
Expand All @@ -48,7 +48,7 @@ const itemRouter = new WorkerRouter()
.get('/', (req, { params }) => ok(`Matched "/item/`))
.get('/:id', (req, { params }) => ok(`Matched "/item/${params.id}`))

const router = new WorkersRouter()
const router = new WorkerRouter()
.get('/', () => ok('Main Page'))
.use('/item*', itemRouter)
```
Expand All @@ -60,7 +60,7 @@ For example, the following router, meant to be used in a Service Worker, can han

```js
// file: "sw.js"
const router = new WorkersRouter()
const router = new WorkerRouter()
.get('/', () => ok('Main Page'))
.get('/about', () => ok('About Page'))
.external('https://plausible.io/api/*', req => {
Expand All @@ -72,7 +72,7 @@ const router = new WorkersRouter()
Worker Router has first class support for error handling. Its main purpose is to let you write your handlers without having to wrap everything inside a massive `try {} catch` block. Instead, you can define special recover routes that get invoked when something goes wrong.

```js
const router = new WorkersRouter()
const router = new WorkerRouter()
.get('/', () => ok('Main Page'))
.get('/about', () => { throw Error('bang') })
.recover('*', (req, { error, response }) =>
Expand Down Expand Up @@ -153,4 +153,4 @@ Worker Tools also includes a number of polyfills that help bridge the gap betwee
[location-polyfill]: https://workers.tools/location-polyfill
[deno-fetch-event-adapter]: https://workers.tools/deno-fetch-event-adapter

Fore more visit [workers.tools](https://workers.tools).
Fore more visit [workers.tools](https://workers.tools).