pds-2021-g2-nest/nest_frontend/objects/Coordinates.js

/**
 * A pair of coordinates, latitude `lat` and longitude `lng`.
 */
import { LatLng } from "leaflet/dist/leaflet-src.esm"
import { SerializationError } from "./Errors"


export default class Coordinates {
    lat
    lng

    /**
     * @param lat - Latitude.
     * @param lng - Longitude.
     */
    constructor(lat, lng) {
        this.lat = lat
        this.lng = lng
    }

    /**
     * Create a new {@link Coordinates} from the format used by the backend.
     *
     * @param str - The string to create the object from.
     * @returns {Coordinates}
     */
    static fromCrawlerString(str) {
        const match = /[{]([0-9.-]+),([0-9.-]+)[}]/.exec(str)
        if(!match) {
            throw new SerializationError(str)
        }
        return new Coordinates(Number(match[1]), Number(match[2]))
    }

    static fromLatLng(latlng) {
        return new Coordinates(latlng.lat, latlng.lng)
    }

    /**
     * @returns {string}
     */
    toString() {
        return `${this.lat} ${this.lng}`
    }

    /**
     * Render the Coordinates as an human-readable string.
     *
     * @returns {string}
     */
    toHumanString() {
        return `${this.lat.toFixed(3)} ${this.lng.toFixed(3)}`
    }

    /**
     * Transform this object in a Geolib compatible-one.
     */
    toGeolib() {
        return {
            latitude: this.lat,
            longitude: this.lng,
        }
    }

    /**
     * Transform this object in a 2-ple.
     *
     * @returns {[Number, Number]}
     */
    toArray() {
        return [this.lat, this.lng]
    }

    /**
     * Transform this object in a {@link LatLng} / Leaflet compatible-one.
     *
     * @returns {LatLng}
     */
    toLatLng() {
        return new LatLng(this.lat, this.lng)
    }
}