Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UpdateOptions<Document>

Options for documents updating.

inheritdoc

FindOptions}

Type parameters

  • Document

Hierarchy

  • Omit<FindOptions<Document>, "sort" | "projection">
    • UpdateOptions

Properties

index

index: IndexedProperty<Document>

Determines on which index to perform search.
When IndexedProperty.value is given, will perform search only on documents having IndexedProperty.name equal to that value.

multiple

multiple: boolean

Whether to return all found documents, or the first one.

default

true

returnUpdated

returnUpdated: boolean

Whether to return updated documents, or the old ones.

default

false