Class Model

Defined in:

src/model.coffee

Overview

Public: the model class

Subclasses

CozyBackedModel, PouchdbBackedModel

Class Method Summary

.all(params, callback) List all instance of a model assume the model has an "all" request
.attachBinary(id, path, data, callback) attach a file to the object
.attachFile(id, path, data, callback) attach a file to the object
Object .cast(attributes, target = {}) cast a POJO using this model schema
.create(data, callback) create a new instance of this model (POST)
.defineRequest(name, request, callback) Define a map/reduce request for this model
.destroy(id, callback) delete a model by its Id
.exists(id, callback) check if a model with given Id exists.
.find(id, callback) find a model by its Id (GET)
.first(callback) Find the first item of this kind useful for singleton type Model
LaterStream .getBinary(id, path, callback) get an attached file as a stream
.getFile(id, path, callback) get an attached file as a stream
.rawRequest(name, params, callback) Get results for defined request for this model pass the results as an array of object with id, key, value properties
.removeBinary(id, path, callback) remove an attached file
.removeFile(id, path, callback) remove an attached file
.removeRequest(name, callback) remove a Request
.request(name, params, callback) Get results for defined request for this model
.requestDestroy(name, params, callback) Destroy results for defined request for this model
.save(id, data, callback) save (create or update) a model whole state (PUT)
.saveBinary(id, path, filePath, callback) [DEPRECATED] save an attached file to disk
.saveFile(id, path, filePath, callback) [DEPRECATED] save an attached file to disk
.search(query, callback) find docs by FTS
.updateAttributes(id, data, callback) change some attributes of the model (PATCH)

Instance Method Summary

::attachBinary(path, data, callback) attach a file to the object Instance version of .attachBinary
::attachFile(path, data, callback) attach a file to the object Instance version of .attachFile
Model ::constructor(attributes) constructor
::destroy(callback) desttroy Remove the model from the DB
::getAttributes() getAttributes
::getBinary(path, callback) get an attached file as a stream Instance version of .getBinary
::getFile(path, callback) get an attached file as a stream Instance version of .getFile
::index(fields, callback) index Index some fields on this model
::removeBinary(path, callback) remove an attached file Instance version of .removeBinary
::removeFile(path, callback) remove an attached file Instance version of .removeFile
::save(callback) [DEPRECATED] save update or create a model
::saveBinary(path, filePath, callback) [DEPRECATED] save an attached file to disk Instance version of .saveBinary
::saveFile(path, filePath, callback) [DEPRECATED] save an attached file to disk Instance version of .saveFile
::updateAttributes(attributes, callback) updateAttributes apply changes to model (dont change other fields)

Class Method Details

.all(params, callback) Source

Public: List all instance of a model assume the model has an "all" request params - optional Object requests params (see couchdb doc) callback - Function(Error err, [Model] results) Returns null

Parameters:

(Object) params — optional Object requests params (see couchdb doc)
(Error) callback — Function(Error err, [Model] results)

Returns:

Returns null

.attachBinary(id, path, data, callback) Source

Public: attach a file to the object id - String, id of the model to update path - String, path or [Buffer](http://nodejs.org/api/buffer.html) or [Stream](http://nodejs.org/api/stream.html) data - Obejct options linked with upload :filename - String Name of the file callback - Function(Error err) Returns null

Parameters:

(String) id — String, id of the model to update
(String) path — String, path or Buffer or Stream
data — Obejct options linked with upload

(String) filename — String Name of the file

(Error) callback — Function(Error err)

Returns:

Returns null

.attachFile(id, path, data, callback) Source

Public: attach a file to the object id - String, id of the model to update path - String path or [Buffer](http://nodejs.org/api/buffer.html) or [Stream](http://nodejs.org/api/stream.html) data - Object options linked with upload :filename - String Name of the file callback - Function(Error err) Returns null

Parameters:

(String) id — String, id of the model to update
(String) path — String path or Buffer or Stream
data — Object options linked with upload

(String) filename — String Name of the file

(Error) callback — Function(Error err)

Returns:

Returns null

Object .cast(attributes, target = {}) Source

Public: cast a POJO using this model schema attributes - Object to cast target - optional Object that will be filled with cast properties Returns Object target

Parameters:

(Object) attributes — Object to cast
(Object) target — optional Object that will be filled with cast properties

Returns:

(Object) — Returns Object target

.create(data, callback) Source

Public: create a new instance of this model (POST) data - Object, arguments for the new model callback - Function(Error err, Model created) Returns null

Parameters:

data — Object, arguments for the new model
(Error) callback — Function(Error err, Model created)

Returns:

Returns null

.defineRequest(name, request, callback) Source

Public: Define a map/reduce request for this model name - String, name of the request request - a single Function (map only) *OR* an object with properties :map - Function :reduce - Function callback - Function(Error err) Returns null

Parameters:

(String) name — String, name of the request
(Function) request — a single Function (map only) OR an object with properties

(Function) map — Function
(Function) reduce — Function

(Error) callback — Function(Error err)

Returns:

Returns null

.destroy(id, callback) Source

Public: delete a model by its Id id - String, id of the model to delete callback - Function(Error err) Returns null

Parameters:

(String) id — String, id of the model to delete
(Error) callback — Function(Error err)

Returns:

Returns null

.exists(id, callback) Source

Public: check if a model with given Id exists. id - String, id of the model we are looking for callback - Function(Error err, Boolean exists) Returns null

Returns:

Returns null

.find(id, callback) Source

Public: find a model by its Id (GET) id - String, id of the model we are looking for callback - Function(Error err, Model result) Returns null

Parameters:

(String) id — String, id of the model we are looking for
(Error) callback — Function(Error err, Model result)

Returns:

Returns null

.first(callback) Source

Public: Find the first item of this kind useful for singleton type Model callback - Function(Error err, Model found or null) Returns null

Parameters:

(Error) callback — Function(Error err, Model found or null)

Returns:

Returns null

LaterStream .getBinary(id, path, callback) Source

Public: get an attached file as a stream id - String, id of the model to update path - String, path or [Buffer](http://nodejs.org/api/buffer.html) or [Stream](http://nodejs.org/api/stream.html) data - Obejct options linked with upload :filename - String Name of the file callback - Function(Error err, [Stream](http://nodejs.org/api/stream.html) file) Returns a LaterStream for the file

Parameters:

(String) id — String, id of the model to update
(String) path — String, path or Buffer or Stream
data — Obejct options linked with upload

(String) filename — String Name of the file

(Error) callback — Function(Error err, Stream file)

Returns:

(LaterStream) — Returns a LaterStream for the file

.getFile(id, path, callback) Source

Parameters:

(String) id — String, id of the model to update
(String) path — String, path or Buffer or Stream
data — Obejct options linked with upload

(String) filename — String Name of the file

(Error) callback — Function(Error err, Stream stream})

Returns:

Returns a Stream for the model

.rawRequest(name, params, callback) Source

Public: Get results for defined request for this model pass the results as an array of object with id, key, value properties name - String, name of the request request - Couchdb query params callback - Function(Error err, ) Returns null

Parameters:

(String) name — String, name of the request
request — Couchdb query params
(Error) callback — Function(Error err, )

Returns:

Returns null

.removeBinary(id, path, callback) Source

Public: remove an attached file id - String, id of the model to update path - String, Name of the attachment callback - Function(Error err) Returns null

Parameters:

(String) id — String, id of the model to update
(String) path — String, Name of the attachment
(Error) callback — Function(Error err)

Returns:

Returns null

.removeFile(id, path, callback) Source

Public: remove an attached file id - String, id of the model to update path - String, Name of the attachment callback - Function(Error err) Returns null

Parameters:

(String) id — String, id of the model to update
(String) path — String, Name of the attachment
(Error) callback — Function(Error err)

Returns:

Returns null

.removeRequest(name, callback) Source

Public: remove a Request name - String, name of the request callback - Function(Error err) Returns null

Parameters:

(String) name — String, name of the request
(Error) callback — Function(Error err)

Returns:

Returns null

.request(name, params, callback) Source

Public: Get results for defined request for this model name - String, name of the request request - Couchdb query params callback - Function(Error err, [Model] results) Returns null

Parameters:

(String) name — String, name of the request
request — Couchdb query params
(Error) callback — Function(Error err, [Model] results)

Returns:

Returns null

.requestDestroy(name, params, callback) Source

Public: Destroy results for defined request for this model name - String, name of the request request - Couchdb query params callback - Function(Error err) Returns null

Parameters:

(String) name — String, name of the request
request — Couchdb query params
(Error) callback — Function(Error err)

Returns:

Returns null

.save(id, data, callback) Source

Public: save (create or update) a model whole state (PUT) id - String, id of the model to update data - Object, new attributes for the model callback - Function(Error err, Model updated) Returns null

Parameters:

(String) id — String, id of the model to update
data — Object, new attributes for the model
(Error) callback — Function(Error err, Model updated)

Returns:

Returns null

.saveBinary(id, path, filePath, callback) Source

Public: [DEPRECATED] save an attached file to disk id - String, id of the model to update path - String, Name of the attachment filePath - String, path to save to callback - Function(Error err) Returns null

Parameters:

(String) id — String, id of the model to update
(String) path — String, Name of the attachment
(String) filePath — String, path to save to
(Error) callback — Function(Error err)

Returns:

Returns null

.saveFile(id, path, filePath, callback) Source

Parameters:

(String) id — String, id of the model to update
(String) path — String, Name of the attachment
(String) filePath — String, path to save to
(Error) callback — Function(Error err)

Returns:

Returns null

.search(query, callback) Source

Public: find docs by FTS query - String, string to search callback - Function(Error err, [Model] results) Returns null

Parameters:

(String) query — String, string to search
(Error) callback — Function(Error err, [Model] results)

Returns:

Returns null

.updateAttributes(id, data, callback) Source

Public: change some attributes of the model (PATCH) id - String, id of the model to update data - Object, changed attributes for the model callback - Function(Error err, Model updated) Returns null

Parameters:

(String) id — String, id of the model to update
data — Object, changed attributes for the model
(Error) callback — Function(Error err, Model updated)

Returns:

Returns null

Constructor Details

Model ::constructor(attributes) Source

Public: constructor attributes - Object, attributes of the model Returns a Model instance

Parameters:

attributes — Object, attributes of the model

Returns:

(Model) — Returns a Model instance

Instance Method Details

::attachBinary(path, data, callback) Source

Public: attach a file to the object Instance version of .attachBinary

::attachFile(path, data, callback) Source

Public: attach a file to the object Instance version of .attachFile

::destroy(callback) Source

Public: desttroy Remove the model from the DB callback - Function (Error err) Returns null

Parameters:

(Error) callback — Function (Error err)

Returns:

Returns null

::getAttributes() Source

Public: getAttributes Returns this model attributes as a POJO Returns Object

Returns:

Returns Object

::getBinary(path, callback) Source

Public: get an attached file as a stream Instance version of .getBinary

::getFile(path, callback) Source

Public: get an attached file as a stream Instance version of .getFile

::index(fields, callback) Source

Public: index Index some fields on this model fields - [String] fields to index callback - Function (Error err) Returns null

Parameters:

(String) fields — [String] fields to index
(Error) callback — Function (Error err)

Returns:

Returns null

::removeBinary(path, callback) Source

Public: remove an attached file Instance version of .removeBinary

::removeFile(path, callback) Source

Public: remove an attached file Instance version of .removeFile

::save(callback) Source

Public: [DEPRECATED] save update or create a model callback - Function(Error err, Model updated) Returns null

Parameters:

(Error) callback — Function(Error err, Model updated)

Returns:

Returns null

::saveBinary(path, filePath, callback) Source

Public: [DEPRECATED] save an attached file to disk Instance version of .saveBinary

::saveFile(path, filePath, callback) Source

Public: [DEPRECATED] save an attached file to disk Instance version of .saveFile

::updateAttributes(attributes, callback) Source

Public: updateAttributes apply changes to model (dont change other fields) attributes - Object changes to apply callback - Function(Error err, Model updated) Returns null

Parameters:

attributes — Object changes to apply
(Error) callback — Function(Error err, Model updated)

Returns:

Returns null