JSDoc: Class: Factory

new Factory()

The base factory class

Source:

factory.js, line 1

Members

collectionTransformer :function

The transformer to be run on a collection (array)

Type:

function

Source:

rest.js, line 192

config :Object

The configuration

Type:

Object

Source:

rest.js, line 168

elementTransformer :function

The transformer to be run on each element

Type:

function

Source:

rest.js, line 180

route :String

The route

Type:

String

Source:

rest.js, line 156

Methods

(static) create(element, fromServeropt) → {Element}

Creates an element

Parameters:

Name	Type	Attributes	Default	Description
`element`	object			The element to create
`fromServer`	Boolean	<optional>	false	Whether this element is from the server or not

Source:

factory.js, line 14

Returns:

Type: Element

(static) customPOST(paramsopt, route=opt) → {Promise.<xhr.response>}

Make a post request

Parameters:

Name	Type	Attributes	Default	Description
`params`	Object	<optional>	{}	The URL parameters for the request
`route=`	String	<optional>		A custom route for the request

Source:

factory.js, line 110

Returns:

The request promise

Type: Promise.<xhr.response>

(static) get(id, paramsopt) → {Promise.<xhr.response>}

Make a get request for a given id

Parameters:

Name	Type	Attributes	Default	Description
`id`	Integer			The id of the element to fetch from the server
`params`	Object	<optional>	{}	The URL parameters for the request

Source:

factory.js, line 90

Returns:

The request promise

Type: Promise.<xhr.response>

(static) getList(paramsopt) → {Promise.<xhr.response>}

Makes a request to the server for an array

Parameters:

Name	Type	Attributes	Default	Description
`params`	Object	<optional>	{}	The URL parameters for the request

Source:

factory.js, line 80

Returns:

The request promise

Type: Promise.<xhr.response>

(static) post(paramsopt, route=opt) → {Promise.<xhr.response>}

Make a post request

Parameters:

Name	Type	Attributes	Default	Description
`params`	Object	<optional>	{}	The URL parameters for the request
`route=`	String	<optional>		A custom route for the request

Source:

factory.js, line 100

Returns:

The request promise

Type: Promise.<xhr.response>