Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FindOptions

Options used to configure find operations.

Hierarchy

  • FindOptions

Index

Constructors

Methods

Constructors

constructor

  • Returns FindOptions

  • Parameters

    Returns FindOptions

Methods

getBatchSize

  • getBatchSize(): number

  • Set the batch size for methods loading found data in batches.

    Returns number

getCollation

  • Set the collation

    Returns CollationOptions

getFields

  • getFields(): {}

  • Set the fields

    Returns {}

    • [key: string]: any

getHint

  • getHint(): {}

  • Set the hint

    Returns {}

    • [key: string]: any

getHintString

  • getHintString(): string

  • Set the hint string

    Returns string

getLimit

  • getLimit(): number

  • Set the limit

    Returns number

getSkip

  • getSkip(): number

  • Set the skip

    Returns number

getSort

  • getSort(): {}

  • Set the sort document

    Returns {}

    • [key: string]: any

setBatchSize

  • Set the batch size for methods loading found data in batches.

    Parameters

    • batchSize: number

    Returns FindOptions

setCollation

  • Set the collation

    Parameters

    Returns FindOptions

setFields

  • Set the fields

    Parameters

    • fields: {}
      • [key: string]: any

    Returns FindOptions

setHint

  • Set the hint

    Parameters

    • hint: {}
      • [key: string]: any

    Returns FindOptions

setHintString

  • Set the hint string

    Parameters

    • hintString: string

    Returns FindOptions

setLimit

  • Set the limit

    Parameters

    • limit: number

    Returns FindOptions

setSkip

  • Set the skip

    Parameters

    • skip: number

    Returns FindOptions

setSort

  • Set the sort document

    Parameters

    • sort: {}
      • [key: string]: any

    Returns FindOptions

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc