Class UpdateOptions

Options for configuring updates.

Hierarchy

UpdateOptions

Index

Constructors

constructor

Methods

Constructors

constructor

new UpdateOptions(): UpdateOptions
new UpdateOptions(obj: UpdateOptions | {}): UpdateOptions

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:958
Returns UpdateOptions
- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:960
Parameters
- obj: UpdateOptions | {}
Returns UpdateOptions

Methods

getArrayFilters

getArrayFilters(): any[]

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:967
Set the arrayFilters option

Returns any[]

getCollation

getCollation(): CollationOptions

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:977
Collation options

Returns CollationOptions

getHint

getHint(): {}

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:987
Set the hint.

Returns {}
- [key: string]: any

getHintString

getHintString(): string

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:997
Set the hint string.

Returns string

getWriteOption

getWriteOption(): WriteOption

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:1037
Set the write option

Returns WriteOption

isMulti

isMulti(): boolean

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:1007
Set whether multi is enabled

Returns boolean

isReturningNewDocument

isReturningNewDocument(): boolean

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:1017
Set whether new document property is enabled. Valid only on findOneAnd* methods.

Returns boolean

isUpsert

isUpsert(): boolean

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:1027
Set whether upsert is enabled

Returns boolean

setArrayFilters

setArrayFilters(arrayFilters: any[]): UpdateOptions

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:972
Set the arrayFilters option

Parameters
- arrayFilters: any[]
Returns UpdateOptions

setCollation

setCollation(collation: CollationOptions): UpdateOptions

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:982
Collation options

Parameters
- collation: CollationOptions
Returns UpdateOptions

setHint

setHint(hint: {}): UpdateOptions

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:992
Set the hint.

Parameters
- hint: {}
  - [key: string]: any
Returns UpdateOptions

setHintString

setHintString(hintString: string): UpdateOptions

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:1002
Set the hint string.

Parameters
- hintString: string
Returns UpdateOptions

setMulti

setMulti(multi: boolean): UpdateOptions

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:1012
Set whether multi is enabled

Parameters
- multi: boolean
Returns UpdateOptions

setReturningNewDocument

setReturningNewDocument(returningNewDocument: boolean): UpdateOptions

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:1022
Set whether new document property is enabled. Valid only on findOneAnd* methods.

Parameters
- returningNewDocument: boolean
Returns UpdateOptions

setUpsert

setUpsert(upsert: boolean): UpdateOptions

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:1032
Set whether upsert is enabled

Parameters
- upsert: boolean
Returns UpdateOptions

setWriteOption

setWriteOption(writeOption: WriteOption): UpdateOptions

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:1042
Set the write option

Parameters
- writeOption: WriteOption
Returns UpdateOptions

toJson

toJson(): {}

- Defined in io.vertx/vertx-mongo-client/target/npm/options.d.ts:1045
Returns {}
- [key: string]: any

Generated using TypeDoc