Extends
Methods
# assertDefined(name)
Verifies that the passed object is one of this collection's instances.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
String | List | Should be a defined ID or doc in this collection. |
If not defined.
# count() → {Number}
Returns the number of documents in this collection.
The number of elements in this collection.
# define(username, slackUser, dmChannel)
Defines a new tuple.
Parameters:
| Name | Type | Description |
|---|---|---|
username |
string | the user's name (e.g. their email address). |
slackUser |
string | the user's slack user. |
dmChannel |
string | the user's direct message channel id. |
# dumpAll() → {Object}
Returns an object with two fields: name and contents. Name is the name of this collection. Contents is an array of objects suitable for passing to the restore() method.
An object representing the contents of this collection.
# dumpOne(docID) → {Object}
Returns an object representing the given docID.
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
string | the ID of the document. |
if docID is not defined.
# find(selector, options) → {Mongo.Cursor}
Runs find on this collection.
Parameters:
| Name | Type | Description |
|---|---|---|
selector |
Object | A MongoDB selector. |
options |
Object | MongoDB options. |
- Overrides:
- See:
# findDoc(name) → {Object}
A stricter form of findOne, in that it throws an exception if the entity isn't found in the collection.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
String | Object | Either the docID, or an object selector, or the 'name' field value. |
If the document cannot be found.
The document associated with name.
# findOne(selector, options) → {Mongo.Cursor}
Runs findOne on this collection.
Parameters:
| Name | Type | Description |
|---|---|---|
selector |
Object | A MongoDB selector. |
options |
Object | MongoDB options. |
- Overrides:
- See:
# getCollectionName() → {string}
Returns the collection name.
- Overrides:
The collection name as a string.
# getPublicationName() → {String}
Return the publication name.
- Overrides:
The publication name, as a string.
# isDefined(name) → {boolean}
Returns true if the passed entity is in this collection.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
String | Object | The docID, or an object specifying a documennt. |
True if name exists in this collection.
# publish()
Default publication method for entities. It publishes the entire collection. This should be overridden in subclasses.
# removeIt(name) → {boolean}
Removes the tuple.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | the name/username. |
- Overrides:
# restoreAll(dumpObjects)
Defines all the entities in the passed array of objects.
Parameters:
| Name | Type | Description |
|---|---|---|
dumpObjects |
The array of objects representing the definition of a document in this collection. |
# restoreOne(dumpObject) → {String}
Defines the entity represented by dumpObject. Defaults to calling the define() method if it exists.
Parameters:
| Name | Type | Description |
|---|---|---|
dumpObject |
An object representing one document in this collection. |
The docID of the newly created document.
# subscribe()
Default subscription method for entities. It subscribes to the entire collection. Should be overridden in subclass
# update(selector, modifier)
Runs a simplified version of update on this collection. This method must be overriden in subclasses.
Parameters:
| Name | Type | Description |
|---|---|---|
selector |
Object | A MongoDB selector. |
modifier |
Object | A MongoDB modifier |