Class default<T>

Type Parameters

Hierarchy

EventEmitter
- default

Indexable

[key: string]: any

Index

Constructors

constructor

new default<T>(
name: string,
schema_?: Record<string, AddSchemaTypeOptions> | default<T>,
): default<T>
Model constructor.
Type Parameters
- T
Parameters
- name: string
  Model name
- Optionalschema_: Record<string, AddSchemaTypeOptions> | default<T>
  Schema
Returns default<T>
Overrides EventEmitter.constructor
- Defined in model.ts:36

Properties

_database

_database: default

_dataKeys

_dataKeys: string[] = []

_mutex

_mutex: default = ...

data

data: Record<PropertyKey, T> = {}

dirty

dirty: boolean = false

Document

Document: new <T>(data: T) => default<T>

each

each: {
    (iterator: (value: default<T>, index: number) => void): void;
    (
        iterator: (value: T, index: number) => void,
        options: Partial<Omit<Options, "lean">> & { lean: true },
    ): void;
    (
        iterator: (value: default<T>, index: number) => void,
        options: Partial<Omit<Options, "lean">> & { lean: false },
    ): void;
    (
        iterator: (value: default<T>, index: number) => void,
        options: Partial<Omit<Options, "lean">> & { lean?: undefined },
    ): void;
    (
        iterator:
            | (value: T, index: number) => void
            | (value: default<T>, index: number) => void,
        options: Partial<Options>,
    ): void;
}

Type declaration

- (iterator: (value: default<T>, index: number) => void): void
- Iterates over all documents.
  Parameters
  - iterator: (value: default<T>, index: number) => void
  Returns void
- (
  iterator: (value: T, index: number) => void,
  options: Partial<Omit<Options, "lean">> & { lean: true },
  ): void
- Iterates over all documents.
  Parameters
  - iterator: (value: T, index: number) => void
  - options: Partial<Omit<Options, "lean">> & { lean: true }
    See Model#findById.
  Returns void
- (
  iterator: (value: default<T>, index: number) => void,
  options: Partial<Omit<Options, "lean">> & { lean: false },
  ): void
- Iterates over all documents.
  Parameters
  - iterator: (value: default<T>, index: number) => void
  - options: Partial<Omit<Options, "lean">> & { lean: false }
    See Model#findById.
  Returns void
- (
  iterator: (value: default<T>, index: number) => void,
  options: Partial<Omit<Options, "lean">> & { lean?: undefined },
  ): void
- Iterates over all documents.
  Parameters
  - iterator: (value: default<T>, index: number) => void
  - options: Partial<Omit<Options, "lean">> & { lean?: undefined }
    See Model#findById.
  Returns void
- (
      iterator:
          | (value: T, index: number) => void
          | (value: default<T>, index: number) => void,
      options: Partial<Options>,
  ): void
- Iterates over all documents.
  Parameters
  - iterator: (value: T, index: number) => void | (value: default<T>, index: number) => void
  - options: Partial<Options>
    See Model#findById.
  Returns void

get

get: {
    (id: PropertyKey): default<T>;
    (
        id: PropertyKey,
        options_: Partial<Omit<Options, "lean">> & { lean: true },
    ): T;
    (
        id: PropertyKey,
        options_: Partial<Omit<Options, "lean">> & { lean: false },
    ): default<T>;
    (
        id: PropertyKey,
        options_: Partial<Omit<Options, "lean">> & { lean?: undefined },
    ): default<T>;
    (id: PropertyKey, options_: Partial<Options>): T | default<T>;
}

Type declaration

- (id: PropertyKey): default<T>
- Finds a document by its identifier.
  Parameters
  - id: PropertyKey
  Returns default<T>
- (id: PropertyKey, options_: Partial<Omit<Options, "lean">> & { lean: true }): T
- Finds a document by its identifier.
  Parameters
  - id: PropertyKey
  - options_: Partial<Omit<Options, "lean">> & { lean: true }
  Returns T
- (
  id: PropertyKey,
  options_: Partial<Omit<Options, "lean">> & { lean: false },
  ): default<T>
- Finds a document by its identifier.
  Parameters
  - id: PropertyKey
  - options_: Partial<Omit<Options, "lean">> & { lean: false }
  Returns default<T>
- (
  id: PropertyKey,
  options_: Partial<Omit<Options, "lean">> & { lean?: undefined },
  ): default<T>
- Finds a document by its identifier.
  Parameters
  - id: PropertyKey
  - options_: Partial<Omit<Options, "lean">> & { lean?: undefined }
  Returns default<T>
- (id: PropertyKey, options_: Partial<Options>): T | default<T>
- Finds a document by its identifier.
  Parameters
  - id: PropertyKey
  - options_: Partial<Options>
  Returns T | default<T>

length

length: number = 0

name

name: string

Model name

Query

Query: new <T>(data: default<T>[]) => default<T>

random

random: () => default<T>

Type declaration

- (): default<T>
- Returns documents in random order.
  
  Returns default<T>

schema

schema: default<T>

size

size: () => number

Type declaration

- (): number
- Returns the number of elements.
  
  Returns number

Accessors

dataKeys

get dataKeys(): string[]
Returns the cached data keys.

Returns string[]
- Defined in model.ts:93

Methods

count

count(): number
Returns the number of elements.

Returns number
- Defined in model.ts:439

destroy

destroy(): void
Deletes a model.

Returns void
- Defined in model.ts:430

eq

eq(i_: number): default<T>
Returns the document at the specified index. num can be a positive or negative number.
Parameters
- i_: number
Returns default<T>
- Defined in model.ts:572
eq(i_: number, options: Partial<Omit<Options, "lean">> & { lean: true }): T
Returns the document at the specified index. num can be a positive or negative number.
Parameters
- i_: number
- options: Partial<Omit<Options, "lean">> & { lean: true }
  See Model#findById.
Returns T
- Defined in model.ts:573
eq(
i_: number,
options: Partial<Omit<Options, "lean">> & { lean: false },
): default<T>
Returns the document at the specified index. num can be a positive or negative number.
Parameters
- i_: number
- options: Partial<Omit<Options, "lean">> & { lean: false }
  See Model#findById.
Returns default<T>
- Defined in model.ts:574
eq(
i_: number,
options: Partial<Omit<Options, "lean">> & { lean?: undefined },
): default<T>
Returns the document at the specified index. num can be a positive or negative number.
Parameters
- i_: number
- options: Partial<Omit<Options, "lean">> & { lean?: undefined }
  See Model#findById.
Returns default<T>
- Defined in model.ts:575
eq(i_: number, options: Partial<Options>): T | default<T>
Returns the document at the specified index. num can be a positive or negative number.
Parameters
- i_: number
- options: Partial<Options>
  See Model#findById.
Returns T | default<T>
- Defined in model.ts:576

every

every(iterator: (value: default<T>, index: number) => boolean): boolean
Tests whether all documents pass the test implemented by the provided function.
Parameters
- iterator: (value: default<T>, index: number) => boolean
Returns boolean
- Defined in model.ts:818

filter

filter(iterator: (value: default<T>, index: number) => boolean): default<T>
Creates a new array with all documents that pass the test implemented by the provided function.
Parameters
- iterator: (value: default<T>, index: number) => boolean
Returns default<T>
- Defined in model.ts:796
filter(
iterator: (value: T, index: number) => boolean,
options: Partial<Omit<Options, "lean">> & { lean: true },
): default<T>
Creates a new array with all documents that pass the test implemented by the provided function.
Parameters
- iterator: (value: T, index: number) => boolean
- options: Partial<Omit<Options, "lean">> & { lean: true }
Returns default<T>
- Defined in model.ts:797
filter(
iterator: (value: default<T>, index: number) => boolean,
options: Partial<Omit<Options, "lean">> & { lean: false },
): default<T>
Creates a new array with all documents that pass the test implemented by the provided function.
Parameters
- iterator: (value: default<T>, index: number) => boolean
- options: Partial<Omit<Options, "lean">> & { lean: false }
Returns default<T>
- Defined in model.ts:798
filter(
iterator: (value: default<T>, index: number) => boolean,
options: Partial<Omit<Options, "lean">> & { lean?: undefined },
): default<T>
Creates a new array with all documents that pass the test implemented by the provided function.
Parameters
- iterator: (value: default<T>, index: number) => boolean
- options: Partial<Omit<Options, "lean">> & { lean?: undefined }
Returns default<T>
- Defined in model.ts:799
filter(
    iterator:
        | (value: T, index: number) => boolean
        | (value: default<T>, index: number) => boolean,
    options: Partial<Options>,
): default<T>
Creates a new array with all documents that pass the test implemented by the provided function.
Parameters
- iterator:
  | (value: T, index: number) => boolean
  | (value: default<T>, index: number) => boolean
- options: Partial<Options>
Returns default<T>
- Defined in model.ts:800

find

find(query: object): default<T>
Finds matching documents.
Parameters
- query: object
Returns default<T>
- Defined in model.ts:495
find(
query: object,
options: Partial<Omit<Options, "lean">> & { lean: true },
): T[]
Finds matching documents.
Parameters
- query: object
- options: Partial<Omit<Options, "lean">> & { lean: true }
  - limit
    Limits the number of documents returned.
  - skip
    Skips the first elements.
  - lean
    Returns a plain JavaScript object.
  - lean: true
    Returns a plain JavaScript object.
Returns T[]
- Defined in model.ts:496
find(
query: object,
options: Partial<Omit<Options, "lean">> & { lean: false },
): default<T>
Finds matching documents.
Parameters
- query: object
- options: Partial<Omit<Options, "lean">> & { lean: false }
  - limit
    Limits the number of documents returned.
  - skip
    Skips the first elements.
  - lean
    Returns a plain JavaScript object.
  - lean: false
    Returns a plain JavaScript object.
Returns default<T>
- Defined in model.ts:497
find(
query: object,
options: Partial<Omit<Options, "lean">> & { lean?: undefined },
): default<T>
Finds matching documents.
Parameters
- query: object
- options: Partial<Omit<Options, "lean">> & { lean?: undefined }
  - limit
    Limits the number of documents returned.
  - skip
    Skips the first elements.
  - lean
    Returns a plain JavaScript object.
  - Optionallean?: undefined
    Returns a plain JavaScript object.
Returns default<T>
- Defined in model.ts:498
find(query: object, options: Partial<Options>): T[] | default<T>
Finds matching documents.
Parameters
- query: object
- options: Partial<Options>
  - limit
    Limits the number of documents returned.
  - skip
    Skips the first elements.
  - lean
    Returns a plain JavaScript object.
Returns T[] | default<T>
- Defined in model.ts:499

findById

findById(id: PropertyKey): default<T>
Finds a document by its identifier.
Parameters
- id: PropertyKey
Returns default<T>
- Defined in model.ts:119
findById(
id: PropertyKey,
options_: Partial<Omit<Options, "lean">> & { lean: true },
): T
Finds a document by its identifier.
Parameters
- id: PropertyKey
- options_: Partial<Omit<Options, "lean">> & { lean: true }
Returns T
- Defined in model.ts:120
findById(
id: PropertyKey,
options_: Partial<Omit<Options, "lean">> & { lean: false },
): default<T>
Finds a document by its identifier.
Parameters
- id: PropertyKey
- options_: Partial<Omit<Options, "lean">> & { lean: false }
Returns default<T>
- Defined in model.ts:121
findById(
id: PropertyKey,
options_: Partial<Omit<Options, "lean">> & { lean?: undefined },
): default<T>
Finds a document by its identifier.
Parameters
- id: PropertyKey
- options_: Partial<Omit<Options, "lean">> & { lean?: undefined }
Returns default<T>
- Defined in model.ts:122
findById(id: PropertyKey, options_: Partial<Options>): T | default<T>
Finds a document by its identifier.
Parameters
- id: PropertyKey
- options_: Partial<Options>
Returns T | default<T>
- Defined in model.ts:123

findOne

findOne(query: object): default<T>
Finds the first matching documents.
Parameters
- query: object
Returns default<T>
- Defined in model.ts:535
findOne(
query: object,
options_: Partial<Omit<Options, "lean">> & { lean: true },
): T
Finds the first matching documents.
Parameters
- query: object
- options_: Partial<Omit<Options, "lean">> & { lean: true }
Returns T
- Defined in model.ts:536
findOne(
query: object,
options_: Partial<Omit<Options, "lean">> & { lean: false },
): default<T>
Finds the first matching documents.
Parameters
- query: object
- options_: Partial<Omit<Options, "lean">> & { lean: false }
Returns default<T>
- Defined in model.ts:537
findOne(
query: object,
options_: Partial<Omit<Options, "lean">> & { lean?: undefined },
): default<T>
Finds the first matching documents.
Parameters
- query: object
- options_: Partial<Omit<Options, "lean">> & { lean?: undefined }
Returns default<T>
- Defined in model.ts:538
findOne(query: object, options_: Partial<Options>): T | default<T>
Finds the first matching documents.
Parameters
- query: object
- options_: Partial<Options>
Returns T | default<T>
- Defined in model.ts:539

first

first(): default<T>
Returns the first document.

Returns default<T>
- Defined in model.ts:602
first(options: Partial<Omit<Options, "lean">> & { lean: true }): T
Returns the first document.
Parameters
- options: Partial<Omit<Options, "lean">> & { lean: true }
  See Model#findById.
Returns T
- Defined in model.ts:603
first(options: Partial<Omit<Options, "lean">> & { lean: false }): default<T>
Returns the first document.
Parameters
- options: Partial<Omit<Options, "lean">> & { lean: false }
  See Model#findById.
Returns default<T>
- Defined in model.ts:604
first(
options: Partial<Omit<Options, "lean">> & { lean?: undefined },
): default<T>
Returns the first document.
Parameters
- options: Partial<Omit<Options, "lean">> & { lean?: undefined }
  See Model#findById.
Returns default<T>
- Defined in model.ts:605
first(options: Partial<Options>): T | default<T>
Returns the first document.
Parameters
- options: Partial<Options>
  See Model#findById.
Returns T | default<T>
- Defined in model.ts:606

forEach

forEach(iterator: (value: default<T>, index: number) => void): void
Iterates over all documents.
Parameters
- iterator: (value: default<T>, index: number) => void
Returns void
- Defined in model.ts:449
forEach(
iterator: (value: T, index: number) => void,
options: Partial<Omit<Options, "lean">> & { lean: true },
): void
Iterates over all documents.
Parameters
- iterator: (value: T, index: number) => void
- options: Partial<Omit<Options, "lean">> & { lean: true }
  See Model#findById.
Returns void
- Defined in model.ts:450
forEach(
iterator: (value: default<T>, index: number) => void,
options: Partial<Omit<Options, "lean">> & { lean: false },
): void
Iterates over all documents.
Parameters
- iterator: (value: default<T>, index: number) => void
- options: Partial<Omit<Options, "lean">> & { lean: false }
  See Model#findById.
Returns void
- Defined in model.ts:451
forEach(
iterator: (value: default<T>, index: number) => void,
options: Partial<Omit<Options, "lean">> & { lean?: undefined },
): void
Iterates over all documents.
Parameters
- iterator: (value: default<T>, index: number) => void
- options: Partial<Omit<Options, "lean">> & { lean?: undefined }
  See Model#findById.
Returns void
- Defined in model.ts:452
forEach(
    iterator:
        | (value: T, index: number) => void
        | (value: default<T>, index: number) => void,
    options: Partial<Options>,
): void
Iterates over all documents.
Parameters
- iterator: (value: T, index: number) => void | (value: default<T>, index: number) => void
- options: Partial<Options>
  See Model#findById.
Returns void
- Defined in model.ts:453

has

has(id: PropertyKey): boolean
Checks if the model contains a document with the specified id.
Parameters
- id: PropertyKey
Returns boolean
- Defined in model.ts:142

insert

insert(
data: T | default<T> | default<T>[] | T[],
callback?: NodeJSLikeCallback<any>,
): Bluebird<any>
Inserts documents.
Parameters
- data: T | default<T> | default<T>[] | T[]
- Optionalcallback: NodeJSLikeCallback<any>
Returns Bluebird<any>
- Defined in model.ts:219

insertOne

insertOne(
data: T | default<T>,
callback?: NodeJSLikeCallback<any>,
): Bluebird<any>
Inserts a document.
Parameters
- data: T | default<T>
- Optionalcallback: NodeJSLikeCallback<any>
Returns Bluebird<any>
- Defined in model.ts:208

last

last(): default<T>
Returns the last document.

Returns default<T>
- Defined in model.ts:617
last(options: Partial<Omit<Options, "lean">> & { lean: true }): T
Returns the last document.
Parameters
- options: Partial<Omit<Options, "lean">> & { lean: true }
  See Model#findById.
Returns T
- Defined in model.ts:618
last(options: Partial<Omit<Options, "lean">> & { lean: false }): default<T>
Returns the last document.
Parameters
- options: Partial<Omit<Options, "lean">> & { lean: false }
  See Model#findById.
Returns default<T>
- Defined in model.ts:619
last(options: Partial<Omit<Options, "lean">> & { lean?: undefined }): default<T>
Returns the last document.
Parameters
- options: Partial<Omit<Options, "lean">> & { lean?: undefined }
  See Model#findById.
Returns default<T>
- Defined in model.ts:620
last(options: Partial<Options>): T | default<T>
Returns the last document.
Parameters
- options: Partial<Options>
  See Model#findById.
Returns T | default<T>
- Defined in model.ts:621

limit

limit(i: number): default<T>
Limits the number of documents returned.
Parameters
- i: number
Returns default<T>
- Defined in model.ts:672

map

map<R>(iterator: (value: default<T>, index: number) => R): R[]
Creates an array of values by iterating each element in the collection.
Type Parameters
- R
Parameters
- iterator: (value: default<T>, index: number) => R
Returns R[]
- Defined in model.ts:711
map<R>(
iterator: (value: T, index: number) => R,
options: Partial<Omit<Options, "lean">> & { lean: true },
): R[]
Creates an array of values by iterating each element in the collection.
Type Parameters
- R
Parameters
- iterator: (value: T, index: number) => R
- options: Partial<Omit<Options, "lean">> & { lean: true }
Returns R[]
- Defined in model.ts:712
map<R>(
iterator: (value: default<T>, index: number) => R,
options: Partial<Omit<Options, "lean">> & { lean: false },
): R[]
Creates an array of values by iterating each element in the collection.
Type Parameters
- R
Parameters
- iterator: (value: default<T>, index: number) => R
- options: Partial<Omit<Options, "lean">> & { lean: false }
Returns R[]
- Defined in model.ts:713
map<R>(
iterator: (value: default<T>, index: number) => R,
options: Partial<Omit<Options, "lean">> & { lean?: undefined },
): R[]
Creates an array of values by iterating each element in the collection.
Type Parameters
- R
Parameters
- iterator: (value: default<T>, index: number) => R
- options: Partial<Omit<Options, "lean">> & { lean?: undefined }
Returns R[]
- Defined in model.ts:714
map<R>(
    iterator:
        | (value: T, index: number) => R
        | (value: default<T>, index: number) => R,
    options: Partial<Options>,
): R[]
Creates an array of values by iterating each element in the collection.
Type Parameters
- R
Parameters
- iterator: (value: T, index: number) => R | (value: default<T>, index: number) => R
- options: Partial<Options>
Returns R[]
- Defined in model.ts:715

new

new(data?: T): default<T>
Creates a new document.
Parameters
- Optionaldata: T
Returns default<T>
- Defined in model.ts:107

populate

populate(
path: string | string[] | Partial<Options> | Partial<Options>[],
): default<T>
Populates document references.
Parameters
- path: string | string[] | Partial<Options> | Partial<Options>[]
Returns default<T>
- Defined in model.ts:971

reduce

reduce<R>(
iterator: (pre: any, cur: default<T>, index: number) => R,
initial?: R,
): R
Reduces a collection to a value which is the accumulated result of iterating each element in the collection.
Type Parameters
- R
Parameters
- iterator: (pre: any, cur: default<T>, index: number) => R
- Optionalinitial: R
  By default, the initial value is the first document.
Returns R
- Defined in model.ts:740

reduceRight

reduceRight<R>(
iterator: (pre: any, cur: default<T>, index: number) => R,
initial?: R,
): R
Reduces a collection to a value which is the accumulated result of iterating each element in the collection from right to left.
Type Parameters
- R
Parameters
- iterator: (pre: any, cur: default<T>, index: number) => R
- Optionalinitial: R
  By default, the initial value is the last document.
Returns R
- Defined in model.ts:768

remove

remove(query: object, callback?: NodeJSLikeCallback<any>): Bluebird<any>
Removes matching documents.
Parameters
- query: object
- Optionalcallback: NodeJSLikeCallback<any>
Returns Bluebird<any>
- Defined in model.ts:423

removeById

removeById(id: string, callback?: NodeJSLikeCallback<any>): Bluebird<any>
Finds a document by its identifier and remove it.
Parameters
- id: string
- Optionalcallback: NodeJSLikeCallback<any>
Returns Bluebird<any>
- Defined in model.ts:412

replace

replace(
    query: object,
    data: T | default<T>,
    callback?: NodeJSLikeCallback<any>,
): Bluebird<any>
Replaces matching documents.
Parameters
- query: object
- data: T | default<T>
- Optionalcallback: NodeJSLikeCallback<any>
Returns Bluebird<any>
- Defined in model.ts:373

replaceById

replaceById(
    id: string,
    data: T | default<T>,
    callback?: NodeJSLikeCallback<any>,
): Bluebird<any>
Finds a document by its identifier and replace it.
Parameters
- id: string
- data: T | default<T>
- Optionalcallback: NodeJSLikeCallback<any>
Returns Bluebird<any>
- Defined in model.ts:361

reverse

reverse(): default<T>
Returns documents in a reversed order.

Returns default<T>
- Defined in model.ts:691

save

save(data: T | default<T>, callback?: NodeJSLikeCallback<any>): Bluebird<any>
Inserts the document if it does not exist; otherwise updates it.
Parameters
- data: T | default<T>
- Optionalcallback: NodeJSLikeCallback<any>
Returns Bluebird<any>
- Defined in model.ts:234

shuffle

shuffle(): default<T>
Returns documents in random order.

Returns default<T>
- Defined in model.ts:700

skip

skip(i: number): default<T>
Specifies the number of items to skip.
Parameters
- i: number
Returns default<T>
- Defined in model.ts:682

slice

slice(start_?: number, end_?: number): default<T>
Returns the specified range of documents.
Parameters
- Optionalstart_: number
- Optionalend_: number
Returns default<T>
- Defined in model.ts:633

some

some(iterator: (value: default<T>, index: number) => boolean): boolean
Tests whether some documents pass the test implemented by the provided function.
Parameters
- iterator: (value: default<T>, index: number) => boolean
Returns boolean
- Defined in model.ts:843

sort

sort(orderby: string, order?: number | "desc" | Record<string, any>): default<T>
Sorts documents. See Query#sort.
Parameters
- orderby: string
- Optionalorder: number | "desc" | Record<string, any>
Returns default<T>
- Defined in model.ts:554
sort(orderby: string): default<T>
Sorts documents. See Query#sort.
Parameters
- orderby: string
Returns default<T>
- Defined in model.ts:555
sort(orderby: Record<string, number | Record<string, any>>): default<T>
Sorts documents. See Query#sort.
Parameters
- orderby: Record<string, number | Record<string, any>>
Returns default<T>
- Defined in model.ts:556

toArray

toArray(): default<T>[]
Returns an array containing all documents.

Returns default<T>[]
- Defined in model.ts:470
toArray(options: Partial<Omit<Options, "lean">> & { lean: true }): T[]
Returns an array containing all documents.
Parameters
- options: Partial<Omit<Options, "lean">> & { lean: true }
  See Model#findById.
Returns T[]
- Defined in model.ts:471
toArray(options: Partial<Omit<Options, "lean">> & { lean: false }): default<T>[]
Returns an array containing all documents.
Parameters
- options: Partial<Omit<Options, "lean">> & { lean: false }
  See Model#findById.
Returns default<T>[]
- Defined in model.ts:472
toArray(
options: Partial<Omit<Options, "lean">> & { lean?: undefined },
): default<T>[]
Returns an array containing all documents.
Parameters
- options: Partial<Omit<Options, "lean">> & { lean?: undefined }
  See Model#findById.
Returns default<T>[]
- Defined in model.ts:473
toArray(options: Partial<Options>): default<T>[] | T[]
Returns an array containing all documents.
Parameters
- options: Partial<Options>
  See Model#findById.
Returns default<T>[] | T[]
- Defined in model.ts:474

toJSON

toJSON(): any[]
Returns any[]
- Defined in model.ts:1034

toJSONStream

toJSONStream(writeStream: Writable): Promise<void>
Parameters
- writeStream: Writable
Returns Promise<void>
- Defined in model.ts:1014

update

update(
    query: object,
    data: object,
    callback?: NodeJSLikeCallback<any>,
): Bluebird<any>
Updates matching documents.
Parameters
- query: object
- data: object
- Optionalcallback: NodeJSLikeCallback<any>
Returns Bluebird<any>
- Defined in model.ts:314

updateById

updateById(
    id: string,
    update: object,
    callback?: NodeJSLikeCallback<any>,
): Bluebird<any>
Finds a document by its identifier and update it.
Parameters
- id: string
- update: object
- Optionalcallback: NodeJSLikeCallback<any>
Returns Bluebird<any>
- Defined in model.ts:299

Class default<T>

Type Parameters

Hierarchy

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns default<T>

Properties

_database

_dataKeys

_mutex

data

dirty

Document

each

Type declaration

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

get

Type declaration

Parameters

Returns default<T>

Parameters

Returns T

Parameters

Returns default<T>

Parameters

Returns default<T>

Parameters

Returns T | default<T>

length

name

Query

random

Type declaration

Returns default<T>

schema

size

Type declaration

Returns number

Accessors

dataKeys

Returns string[]

Methods

count

Returns number

destroy

Returns void

eq

Parameters

Returns default<T>

Parameters

Returns T

Parameters

Returns default<T>

Parameters

Returns default<T>

Parameters

Returns T | default<T>

every

Parameters

Returns boolean

filter

Parameters

Returns default<T>

`Optional`lean?: undefined