FieldTransform

google.firestore.v1.DocumentTransform. FieldTransform

Represents a FieldTransform.

Constructor

new FieldTransform(propertiesopt)

Constructs a new FieldTransform.

Parameters:
Name Type Attributes Description
properties google.firestore.v1.DocumentTransform.IFieldTransform <optional>

Properties to set

Implements:
  • IFieldTransform

Members

(static) ServerValue :string

ServerValue enum.

Properties:
Name Type Description
SERVER_VALUE_UNSPECIFIED string

SERVER_VALUE_UNSPECIFIED value

REQUEST_TIME string

REQUEST_TIME value

appendMissingElements :google.firestore.v1.IArrayValue|null|undefined

FieldTransform appendMissingElements.

fieldPath :string

FieldTransform fieldPath.

increment :google.firestore.v1.IValue|null|undefined

FieldTransform increment.

maximum :google.firestore.v1.IValue|null|undefined

FieldTransform maximum.

minimum :google.firestore.v1.IValue|null|undefined

FieldTransform minimum.

removeAllFromArray :google.firestore.v1.IArrayValue|null|undefined

FieldTransform removeAllFromArray.

setToServerValue :google.firestore.v1.DocumentTransform.FieldTransform.ServerValue

FieldTransform setToServerValue.

transformType :"setToServerValue"|"increment"|"maximum"|"minimum"|"appendMissingElements"|"removeAllFromArray"|undefined

FieldTransform transformType.

Methods

(static) fromObject(object) → {google.firestore.v1.DocumentTransform.FieldTransform}

Creates a FieldTransform message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a FieldTransform message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.firestore.v1.DocumentTransform.FieldTransform

FieldTransform

options $protobuf.IConversionOptions <optional>

Conversion options

toJSON() → {Object.<string, *>}

Converts this FieldTransform to JSON.