SlugCollection

api/slug. SlugCollection

Slugs are unique strings that can be used to identify entities and can be used in URLs.

Constructor

new SlugCollection()

Source:

Creates the Slug collection.

Extends

Methods

assertAllDefined(names)

Source:
Inherited From:

Verifies that the list of passed instances are all members of this collection.

Parameters:
Name Type Description
names

Should be a list of docs and/or docIDs.

Throws:

If instances is not an array, or if any instance is not in this collection.

Type
Meteor.Error

assertDefined(name)

Source:
Inherited From:

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.

Throws:

If not defined.

Type
Meteor.Error

assertSlug(slugName)

Source:

Throws an Error if the passed slugName is not a slugName.

Parameters:
Name Type Description
slugName

The SlugName

Throws:

If the passed slugName is not a slug name.

Type
Meteor.Error

assertValidRoleForMethod(userId)

Source:
Inherited From:

Default implementation of assertValidRoleForMethod. Asserts that userId is logged in as an Admin or Advisor.
This is used in the define, update, and removeIt Meteor methods associated with each class.

Parameters:
Name Type Description
userId

The userId of the logged in user. Can be null or undefined

Throws:

If there is no logged in user, or the user is not an Admin or Advisor.

Type
Meteor.Error

checkIntegrity() → {Array}

Source:
Overrides:

Returns an empty array (no integrity checking done on Slugs.)

Returns:

An empty array.

Type
Array

count() → {Number}

Source:
Inherited From:

Returns the number of documents in this collection.

Returns:

The number of elements in this collection.

Type
Number

define(name, entityName) → {String}

Source:

Creates a new Slug instance and adds it to the collection.

Example
Slugs.define({ name: 'software-engineering', entityName: 'Interest' });
Parameters:
Name Type Description
name String

The name of the slug. Must be globally unique across all entities.

entityName String

The entity it is associated with.

Throws:

If the slug already exists.

Type
Meteor.Error
Returns:

The docID of the created Slug.

Type
String

dumpAll() → {Object}

Source:
Inherited From:

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.

Returns:

An object representing the contents of this collection.

Type
Object

dumpOne(docID) → {Object}

Source:
Overrides:

Returns an object representing the passed slug docID in a format acceptable to define().

Parameters:
Name Type Description
docID

The docID of a Slug.

Returns:

An object representing the definition of docID.

Type
Object

find(selector, options) → {Mongo.Cursor}

Source:
Inherited From:
See:

Runs find on this collection.

Parameters:
Name Type Description
selector Object

A MongoDB selector.

options Object

MongoDB options.

Returns:
Type
Mongo.Cursor

findDoc(name) → {Object}

Source:
Inherited From:

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.

Throws:

If the document cannot be found.

Type
Meteor.Error
Returns:

The document associated with name.

Type
Object

findOne(selector, options) → {Mongo.Cursor}

Source:
Inherited From:
See:

Runs findOne on this collection.

Parameters:
Name Type Description
selector Object

A MongoDB selector.

options Object

MongoDB options.

Returns:
Type
Mongo.Cursor

getCollectionName() → {string}

Source:
Inherited From:

Returns the collection name.

Returns:

The collection name as a string.

Type
string

getEntityID(slugName, entityName) → {String}

Source:

Returns the docID of the entity associated with this Slug.

Parameters:
Name Type Description
slugName String

The slug name or docID.

entityName String

The entity type expected.

Throws:

If the slug or entity cannot be found or is the wrong type.

Type
Meteor.Error
Returns:

The docID of the entity.

Type
String

getNameFromID(slugID)

Source:

Returns the slug name associated with this ID.

Parameters:
Name Type Description
slugID

The slug ID.

Throws:

If the passed slugID is not valid.

Type
Meteor.Error
Returns:

The slug name.

getPublicationName() → {String}

Source:
Inherited From:

Return the publication name.

Returns:

The publication name, as a string.

Type
String

getType() → {String}

Source:
Inherited From:

Return the type of this collection.

Returns:

The type, as a string.

Type
String

hasSlug(slugID) → {boolean}

Source:

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.

Returns:

True if the slugID is in this collection.

Type
boolean

isDefined(name) → {boolean}

Source:
Inherited From:

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.

Returns:

True if name exists in this collection.

Type
boolean

isSlugForEntity(slugName, entityName)

Source:

Returns true if slugName is a slug and is defined for the entity.

Parameters:
Name Type Description
slugName

The slug name.

entityName

The entity for which this might be a defined slug.

Returns:

True if slugName is defined for entityName.

isValidSlugName(slugName) → {boolean}

Source:

Returns true if slugName is syntactically valid (i.e. consists of a-zA-Z0-9 or dash or underscore.)

Parameters:
Name Type Description
slugName

The slug name.

Returns:

True if it's OK.

Type
boolean

publish()

Source:
Inherited From:

Default publication method for entities.
It publishes the entire collection.

removeAll()

Source:
Inherited From:

Removes all elements of this collection.
This is implemented by mapping through all elements because mini-mongo does not implement the remove operation.
So this approach can be used on both client and server side.
removeAll should only used for testing purposes, so it doesn't need to be efficient.

Returns:

true

removeIt(docOrID)

Source:
Overrides:

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)

Source:
Inherited From:

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}

Source:
Inherited From:

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.

Returns:

The docID of the newly created document.

Type
String

subscribe()

Source:
Inherited From:

Default subscription method for entities.
It subscribes to the entire collection.

toString() → {String}

Source:
Inherited From:

Returns a string representing all of the documents in this collection.

Returns:
Type
String

update(selector, modifier)

Source:
Inherited From:
See:

Runs a simplified version of update on this collection.

Parameters:
Name Type Description
selector Object

A MongoDB selector.

modifier Object

A MongoDB modifier

Returns:

true

updateEntityID(slugID, entityID)

Source:

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.