VectorValue

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

class VectorValue {

isEqual(other: VectorValue): boolean;

toArray(): number[];

toJSON(): object;

static fromJSON(json: object): VectorValue;

}

§Methods

isEqual(other: VectorValue): boolean

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

toArray(): number[]

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

toJSON(): object

Returns a JSON-serializable representation of this VectorValue instance.

@return

a JSON representation of this object.

fromJSON(json: object): VectorValue

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

@param json

a JSON object represention of a VectorValue instance.

@return

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