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.
# assertSlug(slugName)
Throws an Error if the passed slugName is not a slugName.
Parameters:
| Name | Type | Description |
|---|---|---|
slugName |
The SlugName |
If the passed slugName is not a slug name.
# checkIntegrity() → {Array}
Returns an empty array (no integrity checking done on Slugs.)
An empty array.
# count() → {Number}
Returns the number of documents in this collection.
The number of elements in this collection.
# define(name) → {String}
Creates a new Slug instance and adds it to the collection.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
String | The name of the slug. Must be globally unique across all entities. |
If the slug already exists.
The docID of the created Slug.
Example
Slugs.define({ name: 'software-engineering' });# 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 passed slug docID in a format acceptable to define().
Parameters:
| Name | Type | Description |
|---|---|---|
docID |
The docID of a Slug. |
An object representing the definition of docID.
# 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.
# getEntityID(slugName) → {String}
Returns the docID of the entity associated with this Slug.
Parameters:
| Name | Type | Description |
|---|---|---|
slugName |
String | The slug name or docID. |
If the slug or entity cannot be found or is the wrong type.
The docID of the entity.
# getNameFromID(slugID)
Returns the slug name associated with this ID.
Parameters:
| Name | Type | Description |
|---|---|---|
slugID |
The slug ID. |
If the passed slugID is not valid.
The slug name.
# getPublicationName() → {String}
Return the publication name.
- Overrides:
The publication name, as a string.
# hasSlug(slugID) → {boolean}
Returns true if the passed slugID is defined in this collection. In the case of SlugCollection, hasSlug is a synonym for isDefined, and you should use isDefined instead.
Parameters:
| Name | Type | Description |
|---|---|---|
slugID |
String | A docID. |
True if the slugID is in this collection.
# 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.
# isValidSlugName(slugName) → {boolean}
Returns true if slugName is syntactically valid (i.e. consists of a-zA-Z0-9 or dash or underscore.)
Parameters:
| Name | Type | Description |
|---|---|---|
slugName |
string | The slug name. |
True if it's OK.
# publish()
Default publication method for entities. It publishes the entire collection. This should be overridden in subclasses.
# removeIt(docOrID)
A stricter form of remove that throws an error if the document or docID could not be found in this collection.
Parameters:
| Name | Type | Description |
|---|---|---|
docOrID |
String | Object | A document or docID in this collection. |
# 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 |
# updateEntityID(slugID, entityID)
Updates a Slug with the docID of the associated entity.
Parameters:
| Name | Type | Description |
|---|---|---|
slugID |
String | The docID of this Slug. |
entityID |
String | The docID of the entity to be associated with this Slug. |