Sentinel values that can be used when writing documents with set(), create() or update().
FieldValue
Package
@google-cloud/firestore!Constructors
(constructor)()
constructor
();
Constructs a new instance of the FieldValue
class
Methods
arrayRemove(elements)
static
arrayRemove
(...
elements
:
unknown
[])
:
FieldValue
;
Returns a special value that can be used with set(), create() or update() that tells the server to remove the given elements from any array value that already exists on the server. All instances of each element specified will be removed from the array. If the field being modified is not already an array it will be overwritten with an empty array.
| Name | Description |
| elements | unknown[]
The elements to remove from the array. {FieldValue} The FieldValue sentinel for use in a call to set(), create() or update(). |
| Type | Description |
|---|---|
| FieldValue |
arrayUnion(elements)
static
arrayUnion
(...
elements
:
unknown
[])
:
FieldValue
;
Returns a special value that can be used with set(), create() or update() that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements.
| Name | Description |
| elements | unknown[]
The elements to union into the array. {FieldValue} The FieldValue sentinel for use in a call to set(), create() or update(). |
| Type | Description |
|---|---|
| FieldValue |
delete()
static
delete
()
:
FieldValue
;
Returns a sentinel for use with update() or set() with {merge:true} to mark a field for deletion.
| Type | Description |
| FieldValue | {FieldValue} The sentinel value to use in your objects. |
increment(n)
static
increment
(
n
:
number
)
:
FieldValue
;
Returns a special value that can be used with set(), create() or update() that tells the server to increment the the field's current value by the given value.
If either current field value or the operand uses floating point precision, both values will be interpreted as floating point numbers and all arithmetic will follow IEEE 754 semantics. Otherwise, integer precision is kept and the result is capped between -2^63 and 2^63-1.
If the current field value is not of type 'number', or if the field does not yet exist, the transformation will set the field to the given value.
| Name | Description |
| n | number
The value to increment by. {FieldValue} The FieldValue sentinel for use in a call to set(), create() or update(). |
| Type | Description |
|---|---|
| FieldValue |
isEqual(other)
isEqual
(
other
:
firestore
.
FieldValue
)
:
boolean
;
Returns true if this FieldValue
is equal to the provided value.
| Name | Description |
| other | firestore.FieldValue
The value to compare against. {boolean} true if this |
| Type | Description |
|---|---|
| boolean |
serverTimestamp()
static
serverTimestamp
()
:
FieldValue
;
Returns a sentinel used with set(), create() or update() to include a server-generated timestamp in the written data.
{FieldValue} The FieldValue sentinel for use in a call to set(), create() or update().
| Type | Description |
|---|---|
| FieldValue |
