Class

SlugCollection

api/slug.SlugCollection()

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

Constructor

# new SlugCollection()

Creates the Slug collection.

View Source api/slug/SlugCollection.ts, line 26

Extends

Methods

# assertAllDefined(names)

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.

Overrides:

View Source api/base/BaseCollection.ts, line 278

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

Meteor.Error

# 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.

Overrides:

View Source api/base/BaseCollection.ts, line 268

If not defined.

Meteor.Error

# assertSlug(slugName)

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

Parameters:
Name Type Description
slugName

The SlugName

View Source api/slug/SlugCollection.ts, line 140

If the passed slugName is not a slug name.

Meteor.Error

# assertValidRoleForMethod(userId)

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

Overrides:

View Source api/base/BaseCollection.ts, line 290

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

Meteor.Error

# checkIntegrity() → {Array}

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

Overrides:

View Source api/slug/SlugCollection.ts, line 149

An empty array.

Array

# count() → {Number}

Returns the number of documents in this collection.

Overrides:

View Source api/base/BaseCollection.ts, line 70

The number of elements in this collection.

Number

# countNonRetired() → {Number}

Returns the number of non-retired documents in this collection.

Overrides:

View Source api/base/BaseCollection.ts, line 77

The number of non-retired elements in this collection.

Number

# define(name, entityName) → {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.

entityName String

The entity it is associated with.

Overrides:

View Source api/slug/SlugCollection.ts, line 49

If the slug already exists.

Meteor.Error

The docID of the created Slug.

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

# 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.

Overrides:

View Source api/base/BaseCollection.ts, line 307

An object representing the contents of this collection.

Object

# 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.

Overrides:

View Source api/slug/SlugCollection.ts, line 157

An object representing the definition of docID.

Object

# 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:

View Source api/base/BaseCollection.ts, line 131

Mongo.Cursor

# 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.

Overrides:

View Source api/base/BaseCollection.ts, line 106

If the document cannot be found.

Meteor.Error

The document associated with name.

Object

# findNonRetired(selector, options) → {Array}

Runs find on this collection and returns the non-retired documents.

Parameters:
Name Type Description
selector Object

A MongoDB selector.

options Object

MongoDB options.

Overrides:
See:

View Source api/base/BaseCollection.ts, line 142

non-retired documents.

Array

# 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:

View Source api/base/BaseCollection.ts, line 153

Mongo.Cursor

# getCollection() → {Mongo.Collection}

Returns the Mongo collection.

Overrides:

View Source api/base/BaseCollection.ts, line 253

The collection.

Mongo.Collection

# getCollectionName() → {string}

Returns the collection name.

Overrides:

View Source api/base/BaseCollection.ts, line 246

The collection name as a string.

string

# getCollectionSchema() → {SimpleSchema}

Returns the schema applied to the collection.

Overrides:

View Source api/base/BaseCollection.ts, line 218

.

SimpleSchema

# getDefineSchema() → {SimpleSchema}

Returns a schema for the define method's parameter.

Overrides:

View Source api/base/BaseCollection.ts, line 225

the define method's parameter.

SimpleSchema

# getEntityID(slugName, entityName) → {String}

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.

View Source api/slug/SlugCollection.ts, line 85

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

Meteor.Error

The docID of the entity.

String

# getNameFromID(slugID)

Returns the slug name associated with this ID.

Parameters:
Name Type Description
slugID

The slug ID.

View Source api/slug/SlugCollection.ts, line 123

If the passed slugID is not valid.

Meteor.Error

The slug name.

# getPublicationName() → {String}

Return the publication name.

Overrides:

View Source api/base/BaseCollection.ts, line 239

The publication name, as a string.

String

# getType() → {String}

Return the type of this collection.

Overrides:

View Source api/base/BaseCollection.ts, line 211

The type, as a string.

String

# getUpdateSchema() → {SimpleSchema}

Returns a schema for the update method's second parameter.

Overrides:

View Source api/base/BaseCollection.ts, line 232

.

SimpleSchema

# 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.

View Source api/slug/SlugCollection.ts, line 114

True if the slugID is in this collection.

boolean

# 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.

Overrides:

View Source api/base/BaseCollection.ts, line 174

True if name exists in this collection.

boolean

# isSlugForEntity(slugName, entityName)

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.

View Source api/slug/SlugCollection.ts, line 101

True if slugName is defined for entityName.

# 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

The slug name.

View Source api/slug/SlugCollection.ts, line 66

True if it's OK.

boolean

# publish()

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

Overrides:

View Source api/base/BaseCollection.ts, line 84

# removeAll()

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.

Overrides:

View Source api/base/BaseCollection.ts, line 200

true

# 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.

Overrides:

View Source api/slug/SlugCollection.ts, line 131

# 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.

Overrides:

View Source api/base/BaseCollection.ts, line 345

# 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.

Overrides:

View Source api/base/BaseCollection.ts, line 335

The docID of the newly created document.

String

# subscribe()

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

Overrides:

View Source api/base/BaseCollection.ts, line 93

# toString() → {String}

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

Overrides:

View Source api/base/BaseCollection.ts, line 260

String

# 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.

View Source api/slug/SlugCollection.ts, line 75