TypeScript and documentation fixes

Fixes #73, Fixes #74

CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Changelog
 
+### 4.1.1 (2020-09-14)
+
+- Fix TypeScript definition for `gstime` (#73).
+- Fix documentation and TypeScript definition for `degreesLong` and `degreesLat` (#74).
+
 ### 4.1.0 (2020-09-14)
 
 - TypeScript support is added via new TypeScript definitions file (#71).

README.md

@@ -188,9 +188,9 @@ var longitude = positionGd.longitude,
     latitude  = positionGd.latitude,
     height    = positionGd.height;
 
-//  Convert the RADIANS to DEGREES for pretty printing (appends "N", "S", "E", "W", etc).
-var longitudeStr = satellite.degreesLong(longitude),
-    latitudeStr  = satellite.degreesLat(latitude);
+//  Convert the RADIANS to DEGREES.
+var longitudeDeg = satellite.degreesLong(longitude),
+    latitudeDeg  = satellite.degreesLat(latitude);
 ```
 
 ## Contributing

package.json

@@ -1,6 +1,6 @@
 {
   "name": "satellite.js",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "description": "SGP4/SDP4 calculation library",
   "main": "lib/index.js",
   "jsnext:main": "dist/satellite.es.js",

types/index.d.ts

@@ -144,10 +144,24 @@ declare module 'satellite.js' {
   export type GMSTime = number;
 
   /**
-   * Convert a date time to GMST
-   * @param date Time to convert
-   */
-  export function gstime(date: Date): GMSTime;
+   * Convert values to GMST. Accepts either a Date object, a Julian date number, or individual date and time
+   * component values. If individual values are specified, all but `msec` are required.
+   * @param dateYearArg Can be a Date, Julian date, or the year number for
+   * @param month Zero-based month number
+   * @param day Day of month
+   * @param hour Hour of day, based on 24 hour clock
+   * @param minute Minute(s)
+   * @param second Second(s)
+   * @param msec Optional milliseconds
+   */
+  export function gstime(
+      dateYearArg: number | Date,
+      month?: number,
+      day?: number,
+      hour?: number,
+      minute?: number,
+      second?: number,
+      msec?: number): GMSTime;
 
   /**
    * Convert ECI to ECF. Units are not modified.
@@ -188,12 +202,12 @@ declare module 'satellite.js' {
   ): number;
 
   /**
-   * Convert the longitude in RADIANS to DEGREES for pretty printing (appends "N", "S", "E", "W", etc).
+   * Convert the longitude in RADIANS to DEGREES.
    */
-  export function degreesLong(longitude: Radians): string;
+  export function degreesLong(longitude: Radians): number;
 
   /**
-   * Convert the latitude in RADIANS to DEGREES for pretty printing (appends "N", "S", "E", "W", etc).
+   * Convert the latitude in RADIANS to DEGREES.
    */
-  export function degreesLat(latitude: Radians): string;
+  export function degreesLat(latitude: Radians): number;
 }