blackburn Defined in lib/index.js

Create a blackburn middleware function that will override res.render to use the blackburn serializers and renderers. The res.render method takes to arguments:

• payload - either a record, an array of records, or an Error object. Can also be a Promise which resolves to any of those.
• options - any options to pass to the serializer or adapter. Blackburn doesn't use any of these options out of the box, but this allows you to pass additional information into any custom adapters or serializers.

res.render() will return a promise which resolves once the response has been rendered.

Example

import blackburn, { RawAdapter } from 'blackburn';

app.use(blackburn({ adapter: RawAdapter })) app.get('/posts', function(req, res, next) { res.render(Post.find()); });

Arguments

• options (Object):
• options.adapter (String,Object):
  • the adapter to use to interrogate model instances
• options.serializers (String,Object):
  • either the path to the directory of serializers, or an object whose keys are model types, and whose values are instances of their respective Serializers. Defaults to 'serializers'. The "application" serializer will be used when no type specific serializer is found.
• options.renderMethodName (String):
  • the name of the render method to attach to the response object. Defaults to 'render', which will override the Express default render method.

Returns