Class ReadPreference

constructor

• new ReadPreference(mode, tags?, options?): ReadPreference

• Parameters

  • mode: ReadPreferenceMode

    A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)
  • Optionaltags: TagSet[]

    A tag set used to target reads to members with the specified tag(s). tagSet is not available if using read preference mode primary.
  • Optionaloptions: ReadPreferenceOptions

    Additional read preference options

  Returns ReadPreference

Optionalhedge

OptionalmaxStalenessSeconds

OptionalminWireVersion

mode

Optionaltags

Staticnearest

StaticNEAREST

Staticprimary

StaticPRIMARY

StaticPRIMARY_PREFERRED

StaticprimaryPreferred

Staticsecondary

StaticSECONDARY

StaticSECONDARY_PREFERRED

StaticsecondaryPreferred

preference

• get preference(): ReadPreferenceMode

• Returns ReadPreferenceMode

equals

• equals(readPreference): boolean

• Check if the two ReadPreferences are equivalent

  Parameters

  • readPreference: ReadPreference

    The read preference with which to check equality

  Returns boolean

isValid

• isValid(mode?): boolean

• Validate if a mode is legal

  Parameters

  • Optionalmode: string

    The string representing the read preference mode.

  Returns boolean

secondaryOk

• secondaryOk(): boolean

• Indicates that this readPreference needs the "SecondaryOk" bit when sent over the wire

  Returns boolean

  See

  https://www.mongodb.com/docs/manual/reference/mongodb-wire-protocol/#op-query

toJSON

• toJSON(): Document

• Return JSON representation

  Returns Document

StaticfromOptions

• fromOptions(options?): undefined | ReadPreference

• Construct a ReadPreference given an options object.

  Parameters

  • Optionaloptions: ReadPreferenceFromOptions

    The options object from which to extract the read preference.

  Returns undefined | ReadPreference

StaticfromString

• fromString(mode): ReadPreference

• Parameters

  • mode: string

  Returns ReadPreference

StaticisValid

• isValid(mode): boolean

• Validate if a mode is legal

  Parameters

  • mode: string

    The string representing the read preference mode.

  Returns boolean

Statictranslate

• translate(options): ReadPreferenceLikeOptions

• Replaces options.readPreference with a ReadPreference instance

  Parameters

  • options: ReadPreferenceLikeOptions

  Returns ReadPreferenceLikeOptions