Interface: FindOneAndUpdateOption
Find One and Update Option parameter.
Hierarchy
IFindOptions↳
FindOneAndUpdateOption
Properties
consistency
• Optional consistency: SearchConsistency
Inherited from
IFindOptions.consistency
Defined in
handler/find/find-options.ts:41
enforceRefCheck
• Optional enforceRefCheck: boolean | "throw"
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
Defined in
model/interfaces/find.interface.ts:24
ignoreCase
• Optional ignoreCase: boolean
Inherited from
IFindOptions.ignoreCase
Defined in
handler/find/find-options.ts:44
lean
• Optional lean: boolean
Inherited from
IFindOptions.lean
Defined in
handler/find/find-options.ts:43
limit
• Optional limit: number
Inherited from
IFindOptions.limit
Defined in
handler/find/find-options.ts:36
maxExpiry
• Optional maxExpiry: number
Overrides
MutationFunctionOptions.maxExpiry
Defined in
model/interfaces/find.interface.ts:17
new
• Optional new: boolean
Default: false if true, return a document after update otherwise return the document before update.
Defined in
model/interfaces/find.interface.ts:16
noCollection
• Optional noCollection: boolean
Inherited from
IFindOptions.noCollection
Defined in
handler/find/find-options.ts:42
populate
• Optional populate: PopulateFieldsType
Inherited from
IFindOptions.populate
Defined in
handler/find/find-options.ts:38
populateMaxDeep
• Optional populateMaxDeep: number
Inherited from
IFindOptions.populateMaxDeep
Defined in
handler/find/find-options.ts:39
select
• Optional select: string | string[] | ISelectType[]
Inherited from
IFindOptions.select
Defined in
handler/find/find-options.ts:40
skip
• Optional skip: number
Inherited from
IFindOptions.skip
Defined in
handler/find/find-options.ts:35
sort
• Optional sort: Record<string, SortType>
Inherited from
IFindOptions.sort
Defined in
handler/find/find-options.ts:37
strict
• Optional strict: ApplyStrategy
Inherited from
MutationFunctionOptions.strict
Defined in
transactionContext
• Optional transactionContext: TransactionAttemptContext
Overrides
MutationFunctionOptions.transactionContext
Defined in
model/interfaces/find.interface.ts:25
upsert
• Optional upsert: boolean
Default: false if true, and no documents found, insert a new document.