2.8 KiB
Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference
{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}
VectorValue class
Represents a vector type in Firestore documents. Create an instance with vector().
Signature:
export declare class VectorValue
Methods
| Method | Modifiers | Description |
|---|---|---|
| fromJSON(json) | static |
Builds a VectorValue instance from a JSON object created by VectorValue.toJSON(). |
| isEqual(other) | Returns true if the two VectorValue values have the same raw number arrays, returns false otherwise. |
|
| toArray() | Returns a copy of the raw number array form of the vector. | |
| toJSON() | Returns a JSON-serializable representation of this VectorValue instance. |
VectorValue.fromJSON()
Builds a VectorValue instance from a JSON object created by VectorValue.toJSON().
Signature:
static fromJSON(json: object): VectorValue;
Parameters
| Parameter | Type | Description |
|---|---|---|
| json | object | a JSON object represention of a VectorValue instance. |
Returns:
an instance of VectorValue if the JSON object could be parsed. Throws a FirestoreError if an error occurs.
VectorValue.isEqual()
Returns true if the two VectorValue values have the same raw number arrays, returns false otherwise.
Signature:
isEqual(other: VectorValue): boolean;
Parameters
| Parameter | Type | Description |
|---|---|---|
| other | VectorValue |
Returns:
boolean
VectorValue.toArray()
Returns a copy of the raw number array form of the vector.
Signature:
toArray(): number[];
Returns:
number[]
VectorValue.toJSON()
Returns a JSON-serializable representation of this VectorValue instance.
Signature:
toJSON(): object;
Returns:
object
a JSON representation of this object.