Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Query<T>

A wrapper class for querying

Type parameters

Hierarchy

  • Query

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Query<T>(mongo: Mongo<T>, match: Match<T>, session?: ClientSession): Query<T>

Properties

Protected Readonly filter

filter: Filter<Document<T>>

Protected Readonly mongo

mongo: Mongo<T>

Protected Optional Readonly session

session?: ClientSession

Methods

deleteMulti

  • deleteMulti(options?: DeleteOptions): Promise<DeleteResult>

  • Delete all matched document

    Parameters

    • Optional options: DeleteOptions

    Returns Promise<DeleteResult>

deleteOne

  • deleteOne(options?: DeleteOptions): Promise<DeleteResult>

  • Delete one matched document

    Parameters

    • Optional options: DeleteOptions

    Returns Promise<DeleteResult>

findMulti

  • findMulti(options?: FindOptions<Document>): Promise<Cursor<T>>

  • Find all matched document

    Parameters

    • Optional options: FindOptions<Document>

    Returns Promise<Cursor<T>>

findOne

  • findOne(options?: FindOptions<Document>): Promise<null | Doc<T>>

  • Find one matched document

    Parameters

    • Optional options: FindOptions<Document>

    Returns Promise<null | Doc<T>>

rename

  • rename(key: string, options?: UpdateOptions): Promise<UpdateResult>

  • Rename a matched document to another key

    Parameters

    • key: string
    • Optional options: UpdateOptions

    Returns Promise<UpdateResult>

updateMulti

  • updateMulti(value: T, options?: UpdateOptions): Promise<UpdateResult>

  • Update all matched document

    Parameters

    • value: T
    • Optional options: UpdateOptions

    Returns Promise<UpdateResult>

updateOne

  • updateOne(value: T, options?: UpdateOptions): Promise<UpdateResult>

  • Update one matched document

    Parameters

    • value: T
    • Optional options: UpdateOptions

    Returns Promise<UpdateResult>

Generated using TypeDoc