Collection

Members

---

documents

Description

Get all documents of the collection.

Returns

Array.<object>

All documents of the collection.

Details

Source

collection.js, line 452

---

name

Description

Get the name of the collection.

Returns

string

Name of the collection.

Details

Source

collection.js, line 461

---

schema

Description

Get the registered schema of the collection.

Returns

Schema

Registered schema of the collection.

Details

Source

collection.js, line 470

---

hasSchema

Description

Get whether the collection has a schema registered.

Returns

boolean

Whether the collection has a schema registered.

Details

Source

collection.js, line 479

---

created

Description

Get the date and time of creation for this collection.

Returns

string

Date and time of creation.

Details

Source

collection.js, line 489

---

firstDocument

Description

Get the first document of the collection.

Returns

object

First document of the collection.

Details

Source

collection.js, line 498

---

lastDocument

Description

Get the last document of the collection.

Returns

object

Last document of the collection.

Details

Source

collection.js, line 507

---

size

Description

Get the amount of documents of the collection.

Returns

number

Amount of documents of the collection.

Details

Source

collection.js, line 516

Methods

---

insert( ...docs ) → {Array.<string>}

Description

Insert new documents into the collection.

Parameters

Name	Type	Attributes	Description
docs	object	<repeatable>	Documents to insert. Passing an array of documents is also supported.

Returns

Array.<string>

IDs of the inserted documents.

Fires

Collection#event:insert After successfully inserting a document.

Details

Source

collection.js, line 39

---

insertOne( doc [, emitEvent ] ) → {string}

Description

Insert a single document into the collection.

Parameters

Name	Type	Attributes	Default	Description
doc	object			Document to insert.
emitEvent	boolean	<optional>	true	Whether to emit the insert event.

Returns

string

ID of the inserted document.

Fires

Collection#event:insert After successfully inserting a document if `emitEvent` is *true*.

Details

Source

collection.js, line 66

---

find( filter, resultInstance ) → {Array.<object>|Result}

Description

Find all documents in the collection that match the query or pass the filter function.

Parameters

Name	Type	Default	Description
filter	object | function		Query object or filter function which will be applied on each document.
resultInstance	boolean	false	Whether to return a Result instance with the matching documents.

Returns

Array.<object> | Result

Matching documents.

Examples

// Find all documents where the value of the property price is greater than or equal to 50.
			collection.find({ price: { greaterThanOrEqual: 50 } });

// Same result but using a function.
			collection.find((doc) => doc.price >= 50);

Fires

Collection#event:find After successfully filtering documents.

Details

Source

collection.js, line 105

---

where( filter, resultInstance ) → {Array.<object>|Result}

Description

Find all documents in the collection that match the query or pass the filter function.

Parameters

Name	Type	Default	Description
filter	object | function		Query object or filter function which will be applied on each document.
resultInstance	boolean	false	Whether to return a Result instance with the matching documents.

Returns

Array.<object> | Result

Matching documents.

Examples

// Find all documents where the value of the property price is greater than or equal to 50.
			collection.find({ price: { greaterThanOrEqual: 50 } });

// Same result but using a function.
			collection.find((doc) => doc.price >= 50);

Fires

Collection#event:find After successfully filtering documents.

Details

Source

collection.js, line 105

---

where( filter, resultInstance ) → {Array.<object>|Result}

Description

Find all documents in the collection that match the query or pass the filter function.

Parameters

Name	Type	Default	Description
filter	object | function		Query object or filter function which will be applied on each document.
resultInstance	boolean	false	Whether to return a Result instance with the matching documents.

Returns

Array.<object> | Result

Matching documents.

Examples

// Find all documents where the value of the property price is greater than or equal to 50.
			collection.find({ price: { greaterThanOrEqual: 50 } });

// Same result but using a function.
			collection.find((doc) => doc.price >= 50);

Fires

Collection#event:find After successfully filtering documents.

Details

Source

collection.js, line 105

---

findOne( filter ) → {object}

Description

Find the first document in the collection that matches the query or passes the filter function.

Parameters

Name	Type	Description
filter	object | function	Query object or filter function which will be applied on each document.

Returns

object

Matching document.

Examples

// Find the first document where the value of the roperty price is greater than or equal to 50.
			collection.findOne({ price: { greaterThanOrEqual: 50 } });

// Same result but using a function.
			collection.findOne((doc) => doc.price >= 50);

Fires

Collection#event:find After successfully filtering documents.

Details

Source

collection.js, line 138

---

findById( id ) → {object}

Description

Find the document with the matching ID.

Parameters

Name	Type	Description
id	string	ID of the document to retrieve.

Returns

object

Matching document.

Examples

collection.findById('1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed');

Details

Source

collection.js, line 162

---

removeExact( doc [, first ] ) → {object|Array.<object>}

Description

Remove all documents matching the given document from the collection.

Parameters

Name	Type	Attributes	Default	Description
doc	object			Document(-s) to remove.
first	boolean	<optional>	false	Whether to remove only the first matching document.

Returns

object | Array.<object>

Removed document(-s).

Examples

// Remove the first matching document.
			collection.removeExact({ price: 50 }, true);

// Remove all matching documents.
			collection.removeExact({ price: 50 });

Fires

Collection#event:remove After successfully removing the document(-s).

Details

Source

collection.js, line 187

---

remove( filter ) → {Array.<object>}

Description

Remove all documents in the collection that match the query or passes the filter function.

Parameters

Name	Type	Description
filter	object | function	Query object or filter function which will be applied on each document.

Returns

Array.<object>

Removed documents.

Examples

// Remove all documents where the value of the
			// property price is greater than or equal to 50.
			collection.remove({ price: { greaterThanOrEqual: 50 } });

// Same result but using a function.
			collection.remove((doc) => doc.price >= 50);

Fires

Collection#event:remove After successfully removing the documents.

Details

Source

collection.js, line 233

---

removeOne( filter ) → {Array.<object>}

Description

Remove the first document in the collection that matches the query or passes the filter function.

Parameters

Name	Type	Description
filter	object | function	Query object or filter function which will be applied on each document.

Returns

Array.<object>

Removed document.

Examples

// Remove the first document where the value of the
			// property price is greater than or equal to 50.
			collection.removeOne({ price: { greaterThanOrEqual: 50 } });
			// or
			collection.removeOne((doc) => doc.price >= 50);

Fires

Collection#event:remove After successfully removing the document.

Details

Source

collection.js, line 273

---

removeById( id ) → {object}

Description

Remove the document with the matching ID.

Parameters

Name	Type	Description
id	string	ID of the document to remove.

Returns

object

Removed document.

Examples

collection.removeById('1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed');

Fires

Collection#event:remove After successfully removing the document.

Details

Source

collection.js, line 303

---

update( filter, updater ) → {Array.<object>}

Description

Update all documents in the collection that match the query or pass the custom filter function.

Parameters

Name	Type	Description
filter	object | function	Query object or filter function which will be applied on each document.
updater	object | function	Object or update function which will be applied on each filtered document.

Returns

Array.<object>

Updated documents.

Examples

// Update all documents where the value of the property price is greater than or equal to 50 and set it to 49.99.
			collection.update(
			  (doc) => doc.price >= 50,
			  { price: 49.99 }
			);

Fires

Collection#event:update After successfully updating the documents.

Details

Source

collection.js, line 333

---

updateById( id, updater ) → {object}

Description

Update the document with the matching ID.

Parameters

Name	Type	Description
id	string	ID of the document to update.
updater	object | function	Object or update function which will be applied on each filtered document.

Returns

object

Updated document.

Examples

collection.updateById(
			 '1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed',
			 { price: 49.99 }
			);

Fires

Collection#event:update After successfully updating the document.

Details

Source

collection.js, line 374

---

registerSchema( schema ) → {Schema}

Description

Register a schema to validate documents inserted into the collection.

Parameters

Name	Type	Description
schema	Schema | object	Schema to validate documents with.

Returns

Schema

Registered schema.

Details

Source

collection.js, line 398

---

unregisterSchema() → {Schema}

Description

Unregister the schema which ultimately stops the collection from validating any further documents.

Returns

Schema

Unregistered schema if there was a registered schema beforehand.

Details

Source

collection.js, line 415

---

cleanWithSchema( [ schema ] ) → {Array.<object>}

Description

Clean the collection from invalid documents using the passed in or registered schema.

Parameters

Name	Type	Attributes	Description
schema	Schema	<optional>	Schema instance to clean collection with.

Returns

Array.<object>

Removed documents.

Details

Source

collection.js, line 428

---

clear() → {Array.<object>}

Description

Clear the collection by deleting all of its documents.

Returns

Array.<object>

All of the removed documents.

Details

Source

collection.js, line 443