Class default<T>Abstract

constructor

• new default<T>(data: default<T>[]): default<T>

• Query constructor.

  Type Parameters

  • T

  Parameters

  • data: default<T>[]

  Returns default<T>

Abstract_model

Abstract_schema

data

each

length

random

size

count

• count(): number

• Returns the number of elements.

  Returns number

  Number

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>

every

• every(iterator: (item: default<T>, index: number) => boolean): boolean

• Tests whether all documents pass the test implemented by the provided function.

  Parameters

  • iterator: (item: default<T>, index: number) => boolean

  Returns boolean

filter

• filter(iterator: (item: 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: (item: default<T>, index: number) => boolean

  Returns default<T>

find

• find(query: object): default<T>

• Finds matching documents.

  Parameters

  • query: object

  Returns default<T>
• 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[]
• 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>
• 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>
• find(query: object, options: Partial<Options>): default<T> | 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 default<T> | T[]

findOne

• findOne(query: object): default<T>

• Finds the first matching documents.

  Parameters

  • query: object

  Returns default<T>
• 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 }

    • skip

      Skips the first elements.

    • lean

      Returns a plain JavaScript object.

    • lean: true

      Returns a plain JavaScript object.

  Returns T
• 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 }

    • skip

      Skips the first elements.

    • lean

      Returns a plain JavaScript object.

    • lean: false

      Returns a plain JavaScript object.

  Returns default<T>
• 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 }

    • skip

      Skips the first elements.

    • lean

      Returns a plain JavaScript object.

    • Optionallean?: undefined

      Returns a plain JavaScript object.

  Returns default<T>
• findOne(query: object, options: Partial<Options>): T | default<T>

• Finds the first matching documents.

  Parameters

  • query: object
  • options: Partial<Options>

    • skip

      Skips the first elements.

    • lean

      Returns a plain JavaScript object.

  Returns T | default<T>

first

• first(): default<T>

• Returns the first document.

  Returns default<T>

forEach

• forEach(iterator: (item: default<T>, index: number) => void): void

• Iterates over all documents.

  Parameters

  • iterator: (item: default<T>, index: number) => void

  Returns void

last

• last(): default<T>

• Returns the last document.

  Returns default<T>

limit

• limit(i: number): default<T>

• Limits the number of documents returned.

  Parameters

  • i: number

  Returns default<T>

map

• map<R>(iterator: (item: default<T>, index: number) => R): R[]

• Creates an array of values by iterating each element in the collection.

  Type Parameters

  • R

  Parameters

  • iterator: (item: default<T>, index: number) => R

  Returns R[]

populate

• populate(
      expr: string | string[] | Partial<Options> | Partial<Options>[],
  ): default<T>

• Populates document references.

  Parameters

  • expr: string | string[] | Partial<Options> | Partial<Options>[]

  Returns default<T>

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

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

remove

• remove(callback?: NodeJSLikeCallback<any>): Bluebird<any>

• Remove all documents.

  Parameters

  • Optionalcallback: NodeJSLikeCallback<any>

  Returns Bluebird<any>

replace

• replace(data: T | default<T>, callback?: NodeJSLikeCallback<any>): Bluebird<any>

• Replace all documents.

  Parameters

  • data: T | default<T>
  • Optionalcallback: NodeJSLikeCallback<any>

  Returns Bluebird<any>

reverse

• reverse(): default<T>

• Returns documents in a reversed order.

  Returns default<T>

shuffle

• shuffle(): default<T>

• Returns documents in random order.

  Returns default<T>

skip

• skip(i: number): default<T>

• Specifies the number of items to skip.

  Parameters

  • i: number

  Returns default<T>

slice

• slice(start: number, end?: number): default<T>

• Returns the specified range of documents.

  Parameters

  • start: number
  • Optionalend: number

  Returns default<T>

some

• some(iterator: (item: default<T>, index: number) => boolean): boolean

• Tests whether some documents pass the test implemented by the provided function.

  Parameters

  • iterator: (item: default<T>, index: number) => boolean

  Returns boolean

sort

• sort(orderby: string, order?: number | "desc" | Record<string, any>): default<T>

• Sorts documents.

  Example:

  query.sort('date', -1);
  query.sort({date: -1, title: 1});
  query.sort('-date title');
  Copy

  If the order equals to -1 or desc, the data will be returned in reversed order.

  Parameters

  • orderby: string
  • Optionalorder: number | "desc" | Record<string, any>

  Returns default<T>
• sort(orderby: string): default<T>

• Sorts documents.

  Example:

  query.sort('date', -1);
  query.sort({date: -1, title: 1});
  query.sort('-date title');
  Copy

  If the order equals to -1 or desc, the data will be returned in reversed order.

  Parameters

  • orderby: string

  Returns default<T>
• sort(orderby: Record<string, number | Record<string, any>>): default<T>

• Sorts documents.

  Example:

  query.sort('date', -1);
  query.sort({date: -1, title: 1});
  query.sort('-date title');
  Copy

  If the order equals to -1 or desc, the data will be returned in reversed order.

  Parameters

  • orderby: Record<string, number | Record<string, any>>

  Returns default<T>

toArray

• toArray(): default<T>[]

• Returns an array containing all documents.

  Returns default<T>[]

update

• update(data: object, callback?: NodeJSLikeCallback<any>): Bluebird<any>

• Update all documents.

  Parameters

  • data: object
  • Optionalcallback: NodeJSLikeCallback<any>

  Returns Bluebird<any>