@jrh-works/route v1.0.0

@jrh-works/route

Basic HTTP request and response handling for Node.js.

For a quickstart, see the usage example.

Installation

npm install @jrh-works/route

The Routing Configuration Function

Usage

const { configureRoute } = require('@jrh-works/route')

Syntax

configureRoute(options)

Arguments

Returns

Exceptions

Throws a standard Error if:

• The options object does not contain a log function.

The Options Object

The Log Function

A function for logging information.

The function should include the properties .error() for logging errors and .request() for logging from an HTTP Request object.

Example Syntax

function log(value) {
  console.log(value)
}

log.error = (error) => {
  console.error(error)
}

log.request = (request) => {
  console.log(request.method, request.url)
}

The Route Function

Syntax

route(handler)

Arguments

Returns

No return value.

Exceptions

Throws a standard Error if:

• A handler function is not present.

Effects

• Information about the request and response will be logged using the log function.

The Handler Function

Syntax

handle(request, response)

Arguments

Returns

Returning a Number

If the handler returns a number, the route will respond with that status (i.e. 200). To include a JSON response in addition to a status, return a RouteResponse.

Exceptions

If the handler throws a standard error:

• The error will be logged using the log function.
• The route will respond with a 500 status.

If the handler throws a handler error:

• The route will respond with the status in the handler error.

The RouteResponse Object

The Handler Error

The handler error can be thrown from within a handler function to customize the error status.

Usage

const { handlerError } = require('@jrh-works/route')

Syntax

handlerError(message, options)

Arguments

The ErrorOptions Object

Usage Example

const { configureRoute, handlerError } = require('@jrh-works/route')
const log = require('./my-logger')

const route = configureRoute({ log })

const handler = (request, response) => {
  if (request.header('Authorization') !== process.env.API_KEY) {
    throw handlerError('Unauthorized request.', { status: 401 })
  }

  return 200
}

module.exports = route(handler)