https://github.com/nicolasparada/node-httptools

HTTP tools for Node.js
https://github.com/nicolasparada/node-httptools

context nodejs npm-package router

Last synced: 6 days ago
JSON representation

HTTP tools for Node.js

• Host: GitHub
• URL: https://github.com/nicolasparada/node-httptools
• Owner: nicolasparada
• License: isc
• Created: 2018-04-15T03:06:17.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2023-03-23T00:53:19.000Z (over 1 year ago)
• Last Synced: 2024-04-14T07:10:36.411Z (7 months ago)
• Topics: context, nodejs, npm-package, router
• Language: JavaScript
• Homepage:
• Size: 30.3 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [@nicolasparada/httptools](https://www.npmjs.com/package/@nicolasparada/httptools)

This package provides some utilities to complement Node's HTTP server.

**Shipped like an ES module.**

Enable support with `--experimental-modules` and Node.js >= v12.0.0.

## Routing

```js

import { createServer } from 'http'

import { createRouter } from '@nicolasparada/httptools'

const router = createRouter()

router.handle('GET', '/', (req, res) => {

    res.end('Hello there 🙂')

})

const server = createServer(router.handler)

server.listen(3000, '127.0.0.1', () => {

    console.log('Server running at http://localhost:3000 🚀')

})

```

You can register HTTP handlers for a given HTTP verb and URL pattern.

## Pattern Matching and Context

```js

import { contextFor, pattern } from '@nicolasparada/httptools'

router.handle('GET', pattern`/hello/{name}`, (req, res) => {

    const ctx = contextFor(req)

    const params = ctx.get('params')

    res.end(`Hello, ${params.name}!`)

})

```

You can create dynamic routes by passing a regular expression. `pattern()` is a tagged template literal function that converts the given pattern into a regular expression for simplicity. In this example, it's equivalent to `/^\/hello\/(?[^\/]+)$/`.

You can capture parameters from the URL with a curly braces syntax as shown there. You can also use a wilcard `*` to capture anything.

Inside the request context, you'll find a "params" object with all the URL parameters.

Context can be filled with your own data. _See [middleware](#middleware) down below._ I do that to not mess with the Node.js API.

## Middleware

```js

router.handle('GET', '/auth_user', withAuthUser(authUserHandler))

function withAuthUser(next) {

    return (req, res) => {

        const token = extractToken(req)

        const authUser = decodeToken(token)

        const ctx = contextFor(req)

        ctx.set('auth_user', authUser)

        return next(req, res)

    }

}

function authUserHandler(req, res) {

    const ctx = contextFor(req)

    const authUser = ctx.get('auth_user')

    res.setHeader('Content-Type', 'application/json; charset=utf-8')

    res.end(JSON.stringify(authUser))

}

```

`contextFor()` will give you a `WeakMap` in which you can save data scoped to the request.

Just use function composition for middleware.

## Sub-routing

```js

import { createRouter, pattern, stripPrefix } from '@nicolasparada/httptools'

const api = createRouter()

api.handle('GET', '/', handler)

const router = createRouter()

router.handle('*', pattern`/api/*`, stripPrefix('/api', api.handler))

```

`stripPrefix()` is a middleware that trims the given prefix from the request URL. That way, you can compose multiple routers.