Class Collection<Document>

Collection of documents which are kept indexed.

Type parameters

Document: DocumentContract<Document>

Type of the document.
Document must implement DocumentContract.

Hierarchy

Collection

Implements

Iterable<Document>

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Collection<Document>(options?: Partial<CollectionOptions<Document>>): Collection<Document>

Type parameters
- Document: DocumentContract<Document, Document>
Parameters
- Optional options: Partial<CollectionOptions<Document>>
Returns Collection<Document>

Accessors

count

get count(): number

Get the number of documents in the Collection.

Returns number

Total number of documents.

indexes

get indexes(): IndexedKey<Document>[]

Returns the indexed properties.

Returns IndexedKey<Document>[]

Methods

[Symbol.iterator]

[Symbol.iterator](): Cursor<Document>

Implementation of Iterable.__@iterator

Iterate over Collection documents.

Returns Cursor<Document>

clear

clear(): void

Clear the Collection by removing all documents.
Emits DocumentNotification with operation DocumentOperation.CLEARED and documents null.
After clearing you can add new documents.

Returns void

createIndexIfMissing

createIndexIfMissing(key: IndexedKey<Document>): boolean

Create index for property only if is not indexed already.

Parameters
- key: IndexedKey<Document>
  
  Key to be indexed.
Returns boolean

Whether index was created or not. Returning false means index was present already.

createIndexes

createIndexes(...keys: IndexedKey<Document>[]): void

Create indexes for document keys.

Parameters
- Rest ...keys: IndexedKey<Document>[]
  
  Keys to be indexed.
Returns void

delete

delete(query: Query<Document>, options?: Partial<DeleteOptions<Document>>): Document[]

Removes documents that match the query. Emits DocumentNotification with operation DocumentOperation.DELETED which contains the deleted documents.
example
Delete document by id
```
collection.delete('unique-id');
```
Delete multiple documents
```
// removes all documents having `fullName` equal to 'John'
const query = {
   fullName: 'John'
};
collection.delete(query);
```
Parameters
- query: Query<Document>
- Optional options: Partial<DeleteOptions<Document>>
Returns Document[]

Deleted documents.

drop

drop(): void

Clear the Collection by removing all documents.
Emits DocumentNotification with operation DocumentOperation.CLEARED and documents null.
After dropping, collection becomes non-reactive, and no more DocumentNotification will be emitted. Therefore it's recommended to not reuse Collection object after this operation.

Returns void

dropIndexes

dropIndexes(...keys: IndexedKey<Document>[]): void

Remove indexes associated with keys.

Parameters
- Rest ...keys: IndexedKey<Document>[]
  
  Name of properties, associated indexes of which needs to be removed.
Returns void

find

find(query?: Query<Document>, options?: Partial<FindOptions<Document>>): Document[]

Selects documents in a collection and returns them.
Found documents are post-processed according to options.

example

Find all documents

collection.find()

Find document by id

collection.find('unique-id')

Find documents by indexed property

// returns all documents having `birthYear` equals to 2000
collection.find(null, {
   index: {
       name: 'birthYear',
       value: 2000
   }
});

Find documents and post-process them

// returns all documents having `birthYear` greater than 2000, sorted by `firstName`
const query = { birthYear: { $gt: 2000 } };
const options = { sort: { firstName: SortDirection.ASCENDING } };
const matches = collection.find(query, options);

Parameters

Optional query: Query<Document>
Optional options: Partial<FindOptions<Document>>

Returns Document[]

insert

insert(documents: Document | Document[]): void

Inserts documents into Collection.
Documents are validated according to JSON Schema (if given).
When documents originality is DocumentOriginality.CLONE, they will be cloned, prior indexing.
After indexing, DocumentNotification which contains inserted documents is emitted.

Parameters
- documents: Document | Document[]
Returns void

map

map<MappedDocument>(mapper: Mapper<Document, MappedDocument>, options?: Partial<IndexOptions<Document>>): MappedDocument[]

Maps Collection documents.
If you need to map only a subset of documents, you can specify an index that needs to be mapped by using options argument.

Type parameters
- MappedDocument
Parameters
- mapper: Mapper<Document, MappedDocument>
  
  Mapping function.
- Optional options: Partial<IndexOptions<Document>>
  
  Options which control set of documents that needs to be mapped.
Returns MappedDocument[]

Mapped documents.

replace

replace(query: Query<Document>, replacement: Document, options?: Partial<ReplaceOptions<Document>>): Document[]

Replace documents that match the query with the replacement.
Emits 2 DocumentNotification when matches were replaced:
1. DocumentOperation.DELETED with the matches that were removed.
2. DocumentOperation.CREATED with the replacement.
example
Replace document by id
```
collection.replace('unique-id', replacement);
```
Replace multiple documents with a single one
```
 // replace all documents having `birthYear` greater than 2000
const query = { birthYear: { $gt: 2000 } };
collection.replace(query, replacement);
```
Insert replacement if no matches found
```
 // no persons with name 'John' are present in the collection
const query = { firstName: 'John' };
collection.replace(query, replacement, { upsert: true });
```
Parameters
- query: Query<Document>
- replacement: Document
- Optional options: Partial<ReplaceOptions<Document>>
Returns Document[]

update

update(query: Query<Document>, update: ObjMap, options?: Partial<UpdateOptions<Document>>): Document[]

Modifies an existing document or documents. The method can modify specific fields of an existing document or documents.
When one of the indexed properties is updated, documents will be re-indexed with the new values of them.
Emits DocumentNotification with operation DocumentOperation.UPDATED which contains the updated documents.

example

Update document by id

const update = {
  $set: {
      birthYear: 2000
  }
};
// returns old document
collection.update('unique-id', update);

Update multiple documents

const update = {
  $inc: {
      salary: 100
  }
};
const query = {
  commits: {
      $gt: 25
  }
};
const options = {
  returnUpdates: true
};
// returns updated documents
collection.update(query, update, options);

Reindex renamed property

const update = {
   $rename: {
       oldIndexName: newName
   }
};
// will de-index renamed index property
collection.update('unique-id', update);

const bringBackIndex = {
  $unset: {
      newName: ''
  },
  $set: {
      oldIndexName: 'new-value'
  }
};
collection.update('unique-id', bringBackIndex);

Parameters

query: Query<Document>
update: ObjMap
Optional options: Partial<UpdateOptions<Document>>

Returns Document[]

watch

watch(): Subscribable<DocumentNotification<Document>>

Watch the collection and receive DocumentNotification when something changes.

Returns Subscribable<DocumentNotification<Document>>

Subscribable for subscribing to notifications.

Class Collection<Document>

Type parameters

Document: DocumentContract<Document>

Hierarchy

Implements

Constructors

Accessors

Methods

Constructors

constructor

Type parameters

Document: DocumentContract<Document, Document>

Parameters

Optional options: Partial<CollectionOptions<Document>>

Returns Collection<Document>

Accessors

count

Returns number

indexes

Returns IndexedKey<Document>[]

Methods

[Symbol.iterator]

Returns Cursor<Document>

clear

Returns void

createIndexIfMissing

Parameters

key: IndexedKey<Document>

Returns boolean

createIndexes

Parameters

Rest ...keys: IndexedKey<Document>[]

Returns void

delete

Delete document by id

Delete multiple documents

Parameters

query: Query<Document>

Optional options: Partial<DeleteOptions<Document>>

Returns Document[]

drop

Returns void

dropIndexes

Parameters

Rest ...keys: IndexedKey<Document>[]

Returns void

find

Find all documents

Find document by id

Find documents by indexed property

Find documents and post-process them

Parameters

Optional query: Query<Document>

Optional options: Partial<FindOptions<Document>>

Returns Document[]

insert

Parameters

documents: Document | Document[]

Returns void

map

Type parameters

MappedDocument

Parameters

mapper: Mapper<Document, MappedDocument>

Optional options: Partial<IndexOptions<Document>>

Returns MappedDocument[]

replace

Replace document by id

Replace multiple documents with a single one

Insert replacement if no matches found

Parameters

query: Query<Document>

replacement: Document

Optional options: Partial<ReplaceOptions<Document>>

Returns Document[]

update

Update document by id

Update multiple documents

Reindex renamed property

Parameters