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
appendMissingElements
FieldTransform appendMissingElements.
fieldPath
FieldTransform fieldPath.
increment
FieldTransform increment.
maximum
FieldTransform maximum.
minimum
FieldTransform minimum.
removeAllFromArray
FieldTransform removeAllFromArray.
setToServerValue
FieldTransform setToServerValue.
transformType
FieldTransform transformType.
ServerValue
ServerValue enum.
Properties:
| Name | Type | Description |
|---|---|---|
SERVER_VALUE_UNSPECIFIED |
string |
SERVER_VALUE_UNSPECIFIED value |
REQUEST_TIME |
string |
REQUEST_TIME value |
Methods
toJSON() → {Object.<string, *>}
Converts this FieldTransform to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(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 |
Returns:
| Type | Description |
|---|---|
| google.firestore.v1.DocumentTransform.FieldTransform |
FieldTransform |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for FieldTransform
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(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 |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |