# @gretzky/loxodrome > navigational function tools Latest version **0.2.1** (published 2022-07-24) · MIT license · 0 weekly downloads ## Install ```sh npm install @gretzky/loxodrome pnpm add @gretzky/loxodrome yarn add @gretzky/loxodrome bun add @gretzky/loxodrome ``` ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.2.1 | | Published | 2022-07-24 | | First published | 2022-07-22 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 0 | | Unpacked size | 48.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Sara Pope | | Maintainers | gretzky | | Keywords | geodesy | ## Links - npm: https://www.npmjs.com/package/@gretzky/loxodrome - Repository: https://github.com/gretzky/loxodrome - Homepage: https://github.com/gretzky/loxodrome#readme - Issues: https://github.com/gretzky/loxodrome/issues - npm.io page: https://npm.io/package/@gretzky/loxodrome ## Recent versions - 0.2.1 (latest) — 2022-07-24 - 0.2.0 — 2022-07-24 - 0.1.1 — 2022-07-22 - 0.1.0 — 2022-07-22 ## README # loxodrome Geodesy and navigational functions ## Usage Install with the package manager of your choice ```bash // or yarn or pnpm npm install @gretzky/loxodrome ``` ## API ### `bearingDistanceTo({ from, to, useRhumbLine }): { initialBearing: number; finalBearing: number }` Returns the initial and final bearing distance between 2 points. | Param | Type | Description | Default | | ------------ | ------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------ | | from | [`Coordinates`](/src/types/coordinates.ts) | set of starting coordinates | **Required** | | to | [`Coordinates`](/src/types/coordinates.ts) | set of ending coordinates | **Required** | | useRhumbLine | `boolean` | whether or not to calculate along a [rhumb line](https://en.wikipedia.org/wiki/Rhumb_line) | **Required** | ### `bearingToDirection(bearing: number, compassPoints: CompassPoints): Windrose` Converts a bearing to a given compass windrose direction. | Param | Type | Description | Default | | ------------- | ---------------------------------------- | ------------------------------- | ------------ | | bearing | `number` | bearing to convert | **Required** | | compassPoints | [`CompassPoints`](/src/types/compass.ts) | number of compass points to use | `16` | ### `convertDistance({ distance, from, to }): number` Converts a distance measurement from one distance unit to another. | Param | Type | Description | Default | | -------- | ----------------------------------------- | ------------------- | ------------ | | distance | `number` | distance to convert | **Required** | | from | [`DistanceUnits`](/src/types/distance.ts) | original unit | **Required** | | to | [`DistanceUnits`](/src/types/distance.ts) | unit to convert to | **Required** | ### `convertSpeed({ speed, from, to }): number` Converts a speed measurement from one unit to another. | Param | Type | Description | Default | | ----- | ----------------------------------- | ------------------ | ------------ | | speed | `number` | speed to convert | **Required** | | from | [`SpeedUnits`](/src/types/speed.ts) | original unit | **Required** | | to | [`SpeedUnits`](/src/types/speed.ts) | unit to convert to | **Required** | ### `ddToDMS(dd: number, direction: "latitude" | "longitude"): string` Converts decimal degrees to decimal minutes | Param | Type | Description | Default | | --------- | --------------------------- | -------------------------- | ------------ | | degrees | `number` | decimal degrees to convert | **Required** | | direction | `"latitude" or "longitude"` | direction of the degrees | **Required** | ### `getCenterOfCoordinates(coordinates: Coordinates[]): Coordinates` Get the latitude and longitude center of an array of coordiantes. | Param | Type | Description | Default | | ----------- | -------------------------------------------- | -------------------- | ------------ | | coordinates | [`Coordinates[]`](/src/types/coordinates.ts) | array of coordinates | **Required** | ### `getRhumbLine({ from, to }): number` Returns the rhumb line between 2 longitudes. | Param | Type | Description | Default | | ----- | -------- | ------------------ | ------------ | | from | `number` | starting longitude | **Required** | | to | `number` | ending longitude | **Required** | ### `getWindroseDirections(compassPoints: CompassPoints): Windrose[]` Returns an array of windrose directions for a given number of compass points. | Param | Type | Description | Default | | ------------- | ---------------------------------------- | ------------------------------- | ------------ | | compassPoints | [`CompassPoints`](/src/types/compass.ts) | number of compass points to use | **Required** | ### `haversine({ from, to, useRhumbLine }): number` Returns the great-circle distance in kilometers between 2 sets of coordinates using the [haversine formula](https://en.wikipedia.org/wiki/Versine#hav). | Param | Type | Description | Default | | ------------ | ------------------------------------------ | ----------------------------------------------------- | ------------ | | from | [`Coordinates`](/src/types/coordinates.ts) | starting coordinates | **Required** | | to | [`Coordinates`](/src/types/coordinates.ts) | ending coordinates | **Required** | | useRhumbLine | `boolean` | whether or not to get the distance along a rhumb line | `false` | ### `midpoint({ from, to, useRhumbLine }): Coordinates` Returns the midpoint coordinate set between 2 coordinates. | Param | Type | Description | Default | | ------------ | ------------------------------------------ | ----------------------------------------------------- | ------------ | | from | [`Coordinates`](/src/types/coordinates.ts) | starting coordinates | **Required** | | to | [`Coordinates`](/src/types/coordinates.ts) | ending coordinates | **Required** | | useRhumbLine | `boolean` | whether or not to get the distance along a rhumb line | `false` | ### `pointsInRange({ from, to, range }): boolean` Returns whether or not 2 points are within a certain statue mile distance from each other. | Param | Type | Description | Default | | ----- | ------------------------------------------ | ---------------------------- | ------------ | | from | [`Coordinates`](/src/types/coordinates.ts) | starting coordinates | **Required** | | to | [`Coordinates`](/src/types/coordinates.ts) | ending coordinates | **Required** | | range | `number` | statute miles to fall within | `false` | ### `vincenty({ from, to }): number` Returns the geodetic distance in kilometers between 2 points using the [Vincenty inverse formula](https://en.wikipedia.org/wiki/Vincenty%27s_formulae). | Param | Type | Description | Default | | ----- | ------------------------------------------ | -------------------- | ------------ | | from | [`Coordinates`](/src/types/coordinates.ts) | starting coordinates | **Required** | | to | [`Coordinates`](/src/types/coordinates.ts) | ending coordinates | **Required** | --- _Source: https://npm.io/package/@gretzky/loxodrome · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._