Class ReadConcern

The MongoDB ReadConcern, which allows for control of the consistency and isolation properties of the data read from replica sets and replica set shards.

see: https://www.mongodb.com/docs/manual/reference/read-concern/index.html

Hierarchy

ReadConcern

Index

Constructors

constructor

Properties

level

Accessors

Methods

Constructors

constructor

new ReadConcern(level: ReadConcernLevel): ReadConcern

- Defined in src/read_concern.ts:29
Constructs a ReadConcern from the read concern level.

Parameters
- level: ReadConcernLevel
Returns ReadConcern

Properties

level

level: string

Accessors

Static AVAILABLE

get AVAILABLE(): "available"

- Defined in src/read_concern.ts:72
Returns "available"

Static LINEARIZABLE

get LINEARIZABLE(): "linearizable"

- Defined in src/read_concern.ts:76
Returns "linearizable"

Static MAJORITY

get MAJORITY(): "majority"

- Defined in src/read_concern.ts:68
Returns "majority"

Static SNAPSHOT

get SNAPSHOT(): "snapshot"

- Defined in src/read_concern.ts:80
Returns "snapshot"

Methods

toJSON

toJSON(): Document

- Defined in src/read_concern.ts:84
Returns Document

Static fromOptions

fromOptions(options?: { level?: ReadConcernLevel; readConcern?: ReadConcernLike }): undefined | ReadConcern

- Defined in src/read_concern.ts:44
Construct a ReadConcern given an options object.

Parameters
- Optional options: { level?: ReadConcernLevel; readConcern?: ReadConcernLike }
  
  The options object from which to extract the write concern.
  - Optional level?: ReadConcernLevel
  - Optional readConcern?: ReadConcernLike
Returns undefined | ReadConcern

Generated using TypeDoc