blackburn

Drop-in serializer support for Express/Connect Node apps.

JSONAPISerializer Defined in lib/serializers/jsonapi.js

Renders the payload according to the JSONAPI 1.0 spec, including related resources, included records, and support for meta and links.

Defined in lib/serializers/jsonapi.js, Line 25

render (payloadoptions)

Take a payload (a model, an array of models, or an Error) and render it as a JSONAPI compliant document

Arguments

payload (Object,Array,Error):
options (Object):

Returns

(Object)

the rendered JSONAPI document

Defined in lib/serializers/jsonapi.js, Line 47

renderPrimary (payloaddocumentoptions)

Render the primary payload for a JSONAPI document (either a model or array of models).

Arguments

payload (Object,Array):
errors or models to render
document (Object):
top level document to render into
options (Object):

Defined in lib/serializers/jsonapi.js, Line 78

renderIncluded (payloaddocumentoptions)

Render any included records into the top level of the document

Arguments

payload (Object,Array):
document (Object):
top level JSONAPI document
options (Object):
options.included (Object):
array of records to sideload

Defined in lib/serializers/jsonapi.js, Line 97

renderMeta (payloaddocumentoptions)

Render top level meta object for a document. Default uses meta supplied in options call to res.render().

Arguments

payload (Object,Array):
document (Object):
top level JSONAPI document
options (Object):
options.meta (Object):

Defined in lib/serializers/jsonapi.js, Line 114

renderLinks (payloaddocumentoptions)

Render top level links object for a document. Defaults to the links supplied in options to res.render().

Arguments

payload (Object,Array):
document (Object):
top level JSONAPI document
options (Object):
options.links (Object):

Defined in lib/serializers/jsonapi.js, Line 131

renderVersion (payloaddocumentoptions)

Render the version of JSONAPI supported.

Arguments

payload (Object,Array):
document (Object):
top level JSONAPI document
options (Object):

Defined in lib/serializers/jsonapi.js, Line 146

renderRecord (optionsrecord)

Render the supplied record as a resource object.

Arguments

options (Object):
record (Object):

Returns

(Object)

a resource object representing the record

Defined in lib/serializers/jsonapi.js, Line 169

attributesForRecord (recordoptions)

Returns the JSONAPI attributes object representing this record's relationships

Arguments

record (Object):
options (Object):

Returns

(Object)

the JSONAPI attributes object

Defined in lib/serializers/jsonapi.js, Line 185

relationshipsForRecord (recordoptions)

Returns the JSONAPI relationships object representing this record's relationships

Arguments

record (Object):
options (Object):

Returns

(Object)

the JSONAPI relationships object

Defined in lib/serializers/jsonapi.js, Line 208

linksForRelationship (namedescriptorrecord)

Takes a relationship descriptor and the record it's for, and returns any links for that relationship for that record. I.e. '/books/1/author'

Arguments

name (String):
name of the relationship
descriptor (Object):
descriptor for the relationship
record (Object):
parent record containing the relationships

Returns

(Object)

the links object for the supplied relationship

Defined in lib/serializers/jsonapi.js, Line 230

dataForRelationship (namedescriptorrecorddocumentoptions)

Takes a relationship descriptor and a record it's for, and returns the data for that relationship. Also sideloads any included records in the top level included namespace.

Arguments

name (String):
name of the relationship
descriptor (Object):
descriptor.data (Array.<Object>,Object,String,Number,Array.<String>,Array.<Number>):
the related id(s) or record(s)
descriptor.config (String,Number):
the user supplied relationship config
record (Object):
the parent record that holds this relationship
document (Object):
top level JSONAPI document
options (Object):

Returns

(Array.<Object>)

array of resource identifiers

Defined in lib/serializers/jsonapi.js, Line 269

metaForRelationship (namedescriptorrecordoptions)

Returns any meta for a given relationship and record. No meta included by default.

Arguments

name (String):
name of the relationship
descriptor (Object):
descriptor for the relationship
record (Object):
parent record containing the relationship
options (Object):

Returns

(Object)

Defined in lib/serializers/jsonapi.js, Line 285

linksForRecord (recordoptions)

Returns links for a particular record, i.e. self: "/books/1"

Arguments

record (Object):
[description]
options (Object):
[description]

Returns

(Object)

[description]

Defined in lib/serializers/jsonapi.js, Line 301

metaForRecord (recordoptions)

Returns meta for a particular record.

Arguments

record (Object):
options (Object):

Returns

(Object)

Defined in lib/serializers/jsonapi.js, Line 313

includeRecord (recorddescriptordocumentoptions)

Sideloads a record into the top level "included" array

Arguments

record (Object):
the record to sideload
descriptor (Object):
descriptor.config (Object):
descriptor.config.type (Object):
descriptor.config.strategy (Object):
descriptor.data (Object):
document (Object):
the top level JSONAPI document
options (Object):

Defined in lib/serializers/jsonapi.js, Line 337

renderError (error)

Render the supplied error

Arguments

error (Error):

Returns

(Object)

the JSONAPI error object

Defined in lib/serializers/jsonapi.js, Line 360

sourceForError (error)

Given an error, return a JSON Pointer, a URL query param name, or other info indicating the source of the error.

Arguments

error (Error):

Returns

(Object)

an error source object, optionally including a "pointer" JSON Pointer or "parameter" for the query param that caused the error.

Defined in lib/serializers/jsonapi.js, Line 375

metaForError (error)

Return the meta for a given error object. You could use this for example, to return debug information in development environments.

Arguments

error (Error):

Returns

(Object)

Defined in lib/serializers/jsonapi.js, Line 387

linksForError (error)

Return a links object for an error. You could use this to link to a bug tracker report of the error, for example.

Arguments

error (Error):

Returns

(Object)

Defined in lib/serializers/jsonapi.js, Line 399

dedupeIncluded (document)

Remove duplicate entries from the sideloaded data.

Arguments

document (Object):
the top level JSONAPI document