api.service.RoutingPolyfillFactory

This service implements a class providing methods for injecting polyfills into request contexts as well as data used by those polyfills. Services Router and Responder are using those methods to augment the APIs of an incoming request and its response.

Commonalities

All methods

• are static.
• expect a request context as sole argument.
• return a polyfill to be injected into the request or response described by provided request context.
• have a name combining the resulting polyfill's target - request or response - and its name.
• are invoked unless the method or information they are providing exist already.

Static properties

ExtensionToMime

This object maps a file's extension into its assumed MIME type.

It is used e.g. to provide a proper value for the Content-Type response header when processing files.

NormalizedIsTests

This object maps convenient shortcuts such as "text" supported by request.is() into patterns for matching the Content-Type header field of a request.

Static methods

requestAccept()

This method provides a normalized and sorted list of MIME types accepted by current request.

The returned value is meant to be exposed as req.accept.

See commonalities of methods.

requestBody()

This method returns a function for fetching (and optionally parsing) the request body.

The returned function is meant to be exposed as req.fetchBody().

See commonalities of methods.

requestIgnore()

This method returns a function stopping current request's dispatching when invoked.

The returned function is meant to be exposed as req.ignore().

See commonalities of methods.

requestIs()

This method returns a function for testing if current request's payload is of a certain type or not.

The returned function is meant to be exposed as req.is().

See commonalities of methods.

requestPath()

This method returns current request's path without any optional query.

The returned value is meant to be exposed as req.path.

See commonalities of methods.

requestQuery()

This method returns an object containing all key-value pairs extracted from current request's query.

The returned value is meant to be exposed as req.query.

See commonalities of methods.

requestRes()

This method returns the response manager associated with current request.

The returned value is meant to be exposed as req.res.

See commonalities of methods.

responseFormat()

This method returns a function offering generation of different response formats based on request's Accept header.

The returned function is meant to be exposed as res.format().

See commonalities of methods.

responseJson()

This method returns a function sending some provided data as JSON-encoded response.

The returned function is meant to be exposed as res.json().

See commonalities of methods.

responseRedirect()

This method returns a function instructing the client to re-fetch a different resource.

The returned function is meant to be exposed as res.redirect().

See commonalities of methods.

responseSend()

This method returns a function sending some provided data as response.

The returned function is meant to be exposed as res.send().

See commonalities of methods.

responseSet()

This method returns a function for assigning value in second argument to the response header named in first argument.

The returned function is meant to be exposed as res.set().

See commonalities of methods.

responseStatus()

This method returns a function conveniently adjusting the response's HTTP status code provided as argument.

The returned function is meant to be exposed as res.status().

See commonalities of methods.

responseType()

This method returns a function conveniently adjusting the response's Content-Type header based on provided argument which may be shortcut listed as key in ExtensionToMime.

The returned function is meant to be exposed as res.type().

See commonalities of methods.