Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CountOptions

Hierarchy

  • CountOptions

Index

Constructors

Methods

Constructors

constructor

  • Returns CountOptions

  • Parameters

    Returns CountOptions

Methods

getCollation

  • Sets the collation options

    Returns CollationOptions

getHint

  • getHint(): {}

  • Optional. The index to use. Specify either the index name as a string or the index specification document.

    Returns {}

    • [key: string]: any

getHintString

  • getHintString(): string

  • Sets the hint to apply. Note: If hint is set, that will be used instead of any hint string.

    Returns string

getLimit

  • getLimit(): number

  • Sets the limit to apply.

    Returns number

getMaxTime

  • getMaxTime(): number

  • Sets the maximum execution time (in ms) on the server for this operation.

    Returns number

getSkip

  • getSkip(): number

  • Optional. The number of matching documents to skip before returning results.

    Returns number

setCollation

  • Sets the collation options

    Parameters

    Returns CountOptions

setHint

  • Optional. The index to use. Specify either the index name as a string or the index specification document.

    Parameters

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

    Returns CountOptions

setHintString

  • Sets the hint to apply. Note: If hint is set, that will be used instead of any hint string.

    Parameters

    • hintString: string

    Returns CountOptions

setLimit

  • Sets the limit to apply.

    Parameters

    • limit: number

    Returns CountOptions

setMaxTime

  • Sets the maximum execution time (in ms) on the server for this operation.

    Parameters

    • maxTime: number

    Returns CountOptions

setSkip

  • Optional. The number of matching documents to skip before returning results.

    Parameters

    • skip: number

    Returns CountOptions

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc