Home Reference Source

References

summary
public

Wrapper for any error that occurred in a policy or store method.

public

C Model

Class that defines an entity type for a record accessible in your API.

public

C Req

A wrapper for the request object with helper methods and access to Autonym model data.

public

C Res

A wrapper for the response object with helper methods and access to Autonym model data.

public

Creates a store that reads and writes data in memory.

public

F createModelMiddleware(config: object): Promise<Router, Error>

Creates an Express middleware router that binds routes for all of the given models.

public

Creates an Express middleware that responds to the request with either the requested data or the error.

public

Options to pass to the JSON schema validator.

public

An object with the key and set to an array of Operands.

public

A plain object that is shared for the given request.

public

An object mapping store method names to policy hooks.

public

An object with the key not set to an Operand.

public

An operand is a boolean (to explicitly allow or deny) or a policy function, or an AndExpression, OrExpression, or NotExpression, which can be used to assemble more complex policies out of a series of policy functions.

public

An object with the key or set to an array of Operands.

public

T Policy: function(req: AutonymReq, res: AutonymRes, meta: Meta): Promise<*, Error> | *

A function that is evaluated before a store method.

public

An object that represents a record that may be operated on by a model.

public

A JSON schema object.

public

A Record that has been transformed by the serialize function as a matter of convenience.

public

An object that has methods for CRUD operations for a typical record.