VectorValue class

Represents a vector type in Firestore documents. Create an instance with vector().

VectorValue

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.

Builds a VectorValue instance from a JSON object created by VectorValue.toJSON().

Signature:

static fromJSON(json: object): VectorValue;

Parameter	Type	Description
json	object	a JSON object represention of a `VectorValue` instance.

Returns:

VectorValue

an instance of VectorValue if the JSON object could be parsed. Throws a FirestoreError if an error occurs.

Returns true if the two VectorValue values have the same raw number arrays, returns false otherwise.

Signature:

isEqual(other: VectorValue): boolean;

Parameter	Type	Description
other	VectorValue

Returns:

boolean

Returns a copy of the raw number array form of the vector.

Signature:

toArray(): number[];

Returns:

number[]

Returns a JSON-serializable representation of this VectorValue instance.

Signature:

toJSON(): object;

Returns:

object

a JSON representation of this object.