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. |
- Inherited From:
If not defined.
# count() → {Number}
Returns the number of documents in this collection.
- Inherited From:
The number of elements in this collection.
# define(obj)
Defines documents in this collection. Must be overridden in subclasses.
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
Object | the object defining the new document. |
- Inherited From:
# 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.
- Inherited From:
An object representing the contents of this collection.
# dumpOne(docID) → {Object}
Returns an object representing the definition of docID in a format appropriate to the restoreOne function. Must be overridden by each collection.
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
String | A docID from this collection. |
- Inherited From:
An object representing this document.
# find(selector, options) → {Mongo.Cursor}
Runs find on this collection.
Parameters:
| Name | Type | Description |
|---|---|---|
selector |
Object | A MongoDB selector. |
options |
Object | MongoDB options. |
- Inherited From:
- 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. |
- Inherited From:
If the document cannot be found.
The document associated with name.
# findDocBySlug(slug) → {Object}
Returns the instance associated with the passed slug.
Parameters:
| Name | Type | Description |
|---|---|---|
slug |
String | The slug (string or docID). |
If the slug cannot be found, or is not associated with an instance in this collection.
The document representing the instance.
# findIdBySlug(slug) → {String}
Return the docID of the instance associated with this slug.
Parameters:
| Name | Type | Description |
|---|---|---|
slug |
String | The slug (string or docID). |
If the slug cannot be found, or is not associated with an instance in this collection.
The docID.
# findIdsBySlugs(slugs) → {Array}
Returns a list of docIDs associated with the instances associated with the list of slugs.
Parameters:
| Name | Type | Description |
|---|---|---|
slugs |
Array | A list or collection of slugs. |
If the slug cannot be found, or is not associated with an instance in this collection.
A list of docIDs.
# findOne(selector, options) → {Mongo.Cursor}
Runs findOne on this collection.
Parameters:
| Name | Type | Description |
|---|---|---|
selector |
Object | A MongoDB selector. |
options |
Object | MongoDB options. |
- Inherited From:
- See:
# findSlugByID(docID) → {String}
Returns the slug name associated with this docID.
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
The docID |
If docID is not associated with this entity.
The slug name
# getCollectionName() → {string}
Returns the collection name.
- Inherited From:
The collection name as a string.
# getID(instance) → {String}
Returns the docID associated with instance, or throws an error if it cannot be found. If instance is an object with an _id field, then that value is checked to see if it's in the collection. If instance is the value for the username field in this collection, then return that document's ID. If instance is a docID, then it is returned unchanged. If instance is a slug, its corresponding docID is returned.
Parameters:
| Name | Type | Description |
|---|---|---|
instance |
String | Either a valid docID or a valid slug string. |
If instance is not a docID or a slug.
The docID associated with instance.
# getIDs(instances) → {Array.<String>}
Returns the docIDs associated with instances, or throws an error if any cannot be found. If an instance is a docID, then it is returned unchanged. If a slug, its corresponding docID is returned. If nothing is passed, then an empty array is returned.
Parameters:
| Name | Type | Description |
|---|---|---|
instances |
Array.<String> | An array of valid docIDs, slugs, or a combination. |
If any instance is not a docID or a slug.
The docIDs associated with instances.
# getPublicationName() → {String}
Return the publication name.
- Inherited From:
The publication name, as a string.
# getSchema() → {SimpleSchema}
Returns the schema attached to this collection.
- Inherited From:
# getType() → {String}
Return the type of this collection.
- Inherited From:
The type, as a string.
# hasSlug(slug) → {boolean}
Returns true if the passed slug is associated with an entity of this type.
Parameters:
| Name | Type | Description |
|---|---|---|
slug |
String | Either the name of a slug or a slugID. |
True if the slug is in this collection.
# isDefined(instance) → {boolean}
Return true if instance is a docID or a slug for this entity.
Parameters:
| Name | Type | Description |
|---|---|---|
instance |
String | A docID or a slug. |
True if instance is a docID or slug for this entity.
# publish()
Default publication method for entities. It publishes the entire collection. This should be overridden in subclasses.
- Inherited From:
# removeIt(instance)
Removes the passed instance from its collection. Also removes the associated Slug. Note that prior to calling this method, the subclass should do additional checks to see if any dependent objects have been deleted.
Parameters:
| Name | Type | Description |
|---|---|---|
instance |
String | A docID or slug representing the instance. |
If the instance (and its associated slug) cannot be found.
# 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. |
- Inherited From:
# 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. |
- Inherited From:
The docID of the newly created document.
# subscribe()
Default subscription method for entities. It subscribes to the entire collection. Should be overridden in subclass
- Inherited From:
# 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 |