Skip to content

docs: make clear that latitude is first on nearbyGPSCoordinate #864

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Apr 22, 2022
Merged

docs: make clear that latitude is first on nearbyGPSCoordinate #864

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d4f0d30
make clear that latitude is first on nearbyGPSCoordinate
efstathiosntonas Apr 22, 2022
c13a4c2
make clear that latitude is first on coordinateWithOffset
efstathiosntonas Apr 22, 2022
0b055df
typed coordinate on coordinateWithOffset params instead of JSDoc
efstathiosntonas Apr 22, 2022
3b4c48f
typed coordinate on nearbyGPSCoordinate params instead of JSDoc
efstathiosntonas Apr 22, 2022
6a8c634
typed return types of nearbyGPSCoordinate
efstathiosntonas Apr 22, 2022
bce1f2c
typed return types of coordinateWithOffset
efstathiosntonas Apr 22, 2022
12afbeb
Merge branch 'main' into patch-1
Shinigami92 Apr 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/address.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ function kilometersToMiles(miles: number): number {
* @param isMetric Metric: true, Miles: false.
*/
function coordinateWithOffset(
coordinate: [number, number],
coordinate: [latitude: number, longitude: number],
bearing: number,
distance: number,
isMetric: boolean
): number[] {
): [latitude: number, longitude: number] {
const R = 6378.137; // Radius of the Earth (http://nssdc.gsfc.nasa.gov/planetary/factsheet/earthfact.html)
const d = isMetric ? distance : kilometersToMiles(distance); // Distance in km

Expand Down Expand Up @@ -492,10 +492,10 @@ export class Address {
*/
// TODO ST-DDT 2022-02-10: Allow coordinate parameter to be [string, string].
nearbyGPSCoordinate(
coordinate?: [number, number],
coordinate?: [latitude: number, longitude: number],
radius?: number,
isMetric?: boolean
): [string, string] {
): [latitude: string, longitude: string] {
// If there is no coordinate, the best we can do is return a random GPS coordinate.
if (coordinate === undefined) {
return [this.latitude(), this.longitude()];
Expand Down