Type alias SetChange

SetChange: [string | KeyPath, unknown]

A key path and value to set on a document as part of an update operation. Specified as part of [[UpdateChangesDocument]], this is a tuple in the form:

[key_path, new_value]

  • key_path is the property path into the document to update (either as a dotted string path e.g. 'profile.name' or a [[KeyPath]])
  • new_value is the value to update the property path to (it cannot be undefined -- if you want to clear the value, see [[DeleteChange]])

Generated using TypeDoc