Class: Resource

ResourceFactory~ Resource

new Resource(attrs)

Resource

Abstract class that provides common behavior and serialization for resources.

Parameters:
Name Type Description
attrs Object

attributes

Source:

Methods

(static) cleanId()

Delete id(s) from the params.

By default removes the id property.

Source:

(static) create(params) → {Promise}

Create a resource.

Parameters:
Name Type Description
params Object

resource data

Source:
Returns:

promise

Type
Promise

(static) get(params) → {Promise}

Fetch resource.

Parameters:
Name Type Description
params Object

parameters for fetch

Source:
Returns:

resource object that will be eventually filled with data

Type
Promise

(static) getId()

Extract resource id from an object.

By default the returns the id property. Override to provide a different value.

Source:

(static) query(params) → {Collection}

Fetch collection.

Parameters:
Name Type Description
params Object

query params

Source:
Returns:

collection and its promise

Type
Collection
Example
var collection = Resource.query();
collection.then(function(data) {
  // data are now fetched
});

(static) update(params) → {Promise}

Update resource.

Parameters:
Name Type Description
params Object
Source:
Returns:

promise

Type
Promise

['delete']() → {Promise}

Delete a resource.

Source:
Returns:

promise

Type
Promise

save() → {Promise}

Save resource.

Source:
Returns:

promise

Type
Promise

url() → {String}

Url of the resource instance.

Source:
Returns:

resource url

Type
String