Skip to main content

Interface: FindOneAndUpdateOption

Defined in: model/interfaces/find.interface.ts:8

Find One and Update Option parameter.

Extends​

Properties​

consistency?​

optional consistency: SearchConsistency

Defined in: handler/find/find-options.ts:41

Inherited from​

IFindOptions.consistency

enforceRefCheck?​

optional enforceRefCheck: boolean | "throw"

Defined in: model/interfaces/find.interface.ts:24

Default: false enforceRefCheck will check if the referenced document exists set to true: will log a warning message. set to 'throw': will throw an exception.

Overrides​

MutationFunctionOptions.enforceRefCheck

ignoreCase?​

optional ignoreCase: boolean

Defined in: handler/find/find-options.ts:44

Inherited from​

IFindOptions.ignoreCase

lean?​

optional lean: boolean

Defined in: handler/find/find-options.ts:43

Inherited from​

IFindOptions.lean

limit?​

optional limit: number

Defined in: handler/find/find-options.ts:36

Inherited from​

IFindOptions.limit

maxExpiry?​

optional maxExpiry: number

Defined in: model/interfaces/find.interface.ts:17

Overrides​

MutationFunctionOptions.maxExpiry

new?​

optional new: boolean

Defined in: model/interfaces/find.interface.ts:16

Default: false if true, return a document after update otherwise return the document before update.

noCollection?​

optional noCollection: boolean

Defined in: handler/find/find-options.ts:42

Inherited from​

IFindOptions.noCollection

populate?​

optional populate: PopulateFieldsType

Defined in: handler/find/find-options.ts:38

Inherited from​

IFindOptions.populate

populateMaxDeep?​

optional populateMaxDeep: number

Defined in: handler/find/find-options.ts:39

Inherited from​

IFindOptions.populateMaxDeep

select?​

optional select: string | string[] | ISelectType[]

Defined in: handler/find/find-options.ts:40

Inherited from​

IFindOptions.select

skip?​

optional skip: number

Defined in: handler/find/find-options.ts:35

Inherited from​

IFindOptions.skip

sort?​

optional sort: Record<string, SortType>

Defined in: handler/find/find-options.ts:37

Inherited from​

IFindOptions.sort

strict?​

optional strict: ApplyStrategy

Defined in: utils/cast-strategy.ts:52

Inherited from​

MutationFunctionOptions.strict

transactionContext?​

optional transactionContext: TransactionAttemptContext

Defined in: model/interfaces/find.interface.ts:25

Overrides​

MutationFunctionOptions.transactionContext

upsert?​

optional upsert: boolean

Defined in: model/interfaces/find.interface.ts:12

Default: false if true, and no documents found, insert a new document.