GeoPoint class

An immutable object representing a geographic location in Firestore. The location is represented as latitude/longitude pair.

Latitude values are in the range of [-90, 90]. Longitude values are in the range of [-180, 180].

Signature:

export declare class GeoPoint 

Constructors

Constructor Modifiers Description
(constructor)(latitude, longitude) Creates a new immutable GeoPoint object with the provided latitude and longitude values.

Properties

Property Modifiers Type Description
latitude number The latitude of this GeoPoint instance.
longitude number The longitude of this GeoPoint instance.

Methods

Method Modifiers Description
isEqual(other) Returns true if this GeoPoint is equal to the provided one.
toJSON() Returns a JSON-serializable representation of this GeoPoint.

GeoPoint.(constructor)

Creates a new immutable GeoPoint object with the provided latitude and longitude values.

Signature:

constructor(latitude: number, longitude: number);

Parameters

Parameter Type Description
latitude number The latitude as number between -90 and 90.
longitude number The longitude as number between -180 and 180.

GeoPoint.latitude

The latitude of this GeoPoint instance.

Signature:

get latitude(): number;

GeoPoint.longitude

The longitude of this GeoPoint instance.

Signature:

get longitude(): number;

GeoPoint.isEqual()

Returns true if this GeoPoint is equal to the provided one.

Signature:

isEqual(other: GeoPoint): boolean;

Parameters

Parameter Type Description
other GeoPoint The GeoPoint to compare against.

Returns:

boolean

true if this GeoPoint is equal to the provided one.

GeoPoint.toJSON()

Returns a JSON-serializable representation of this GeoPoint.

Signature:

toJSON(): {
        latitude: number;
        longitude: number;
    };

Returns:

{ latitude: number; longitude: number; }