Hierarchy

  • IUpdateFieldOptions

Properties

deleteField?: boolean

Optionally, delete the field with fieldName. Use dot notation to access nested fields.

disableCheckEquality?: boolean

Optionally, disable checking if the updated value is equal to the current value. By default, we skip the update if they’re equal.

fieldName: string

The field name to update. Use dot notation to access nested fields.

ignoreRequiredFields?: boolean

If true, ignores checking required fields have values

path: string

The path to the row to update

useArrayRemove?: boolean

Optionally, uses firestore's arrayRemove with the given value. Removes given value items from the existing array

useArrayUnion?: boolean

Optionally, uses firestore's arrayUnion with the given value. Appends given value items to the existing array

value: any

The value to write

Generated using TypeDoc