FieldTransform Object

FieldTransform(
  setToServerValue = NULL,
  minimum = NULL,
  removeAllFromArray = NULL,
  increment = NULL,
  fieldPath = NULL,
  appendMissingElements = NULL,
  maximum = NULL
)

Arguments

setToServerValue

Sets the field to the given server value

minimum

Sets the field to the minimum of its current value and the given value

removeAllFromArray

Remove all of the given elements from the array in the field

increment

Adds the given value to the field's current value

fieldPath

The path of the field

appendMissingElements

Append the given elements in order if they are not already present in the current field value

maximum

Sets the field to the maximum of its current value and the given value

Value

FieldTransform object

Details

Autogenerated via gar_create_api_objects A transformation of a field of the document.