geo-coordinates-parser 1.6.5 → 1.6.6

package/dist/cjs/converter.d.ts

@@ -2,13 +2,21 @@ export default converter;
 /**
  * Function for converting coordinates in a variety of formats to decimal coordinates
  * @param {string} coordsString The coordinates string to convert
- * @param {number} decimalPlaces The number of decimal places for converted coordinates; default is 5
- * @returns {object} { verbatimCoordinates, decimalCoordinates, decimalLatitude, decimalLongitude }
+ * @param {number} [decimalPlaces] The number of decimal places for converted coordinates; default is 5
+ * @returns {{verbatimCoordinates: string, decimalCoordinates: string, decimalLatitude: string, decimalLongitude: string, closeEnough: function(string): boolean, toCoordinateFormat: toCoordinateFormat}}
  */
-declare function converter(coordsString: string, decimalPlaces: number): object;
+declare function converter(coordsString: string, decimalPlaces?: number | undefined): {
+    verbatimCoordinates: string;
+    decimalCoordinates: string;
+    decimalLatitude: string;
+    decimalLongitude: string;
+    closeEnough: (arg0: string) => boolean;
+    toCoordinateFormat: typeof toCoordinateFormat;
+};
 declare namespace converter {
     export { to };
 }
+import toCoordinateFormat from './toCoordinateFormat.js';
 declare const to: Readonly<{
     DMS: "DMS";
     DM: "DM";

package/dist/cjs/converter.js

@@ -10,8 +10,8 @@ const toCoordinateFormat_js_1 = __importDefault(require("./toCoordinateFormat.js
 /**
  * Function for converting coordinates in a variety of formats to decimal coordinates
  * @param {string} coordsString The coordinates string to convert
- * @param {number} decimalPlaces The number of decimal places for converted coordinates; default is 5
- * @returns {object} { verbatimCoordinates, decimalCoordinates, decimalLatitude, decimalLongitude }
+ * @param {number} [decimalPlaces] The number of decimal places for converted coordinates; default is 5
+ * @returns {{verbatimCoordinates: string, decimalCoordinates: string, decimalLatitude: string, decimalLongitude: string, closeEnough: function(string): boolean, toCoordinateFormat: toCoordinateFormat}}
  */
 function converter(coordsString, decimalPlaces) {
     //TODO add exact match to entered string, so that it can be used to filter out superflous text around it

package/dist/cjs/tests/testIndividual.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const converter_js_1 = __importDefault(require("../converter.js"));
 //const test = '26°44S 29°46E'
 //const test = '00.00, 01.00'
-const test = `8°83S 35°67E`;
+const test = `26°05240'S, 27°51448'E`;
 try {
     let converted = (0, converter_js_1.default)(test);
     console.log(converted);

package/dist/cjs/toCoordinateFormat.d.ts

@@ -1,6 +1,7 @@
 export default toCoordinateFormat;
 /**
  * Converts decimalCoordinates to other formats commonly used
- * @param {*} format Either DMS or DM
+ * @param {string} format Either DMS or DM
+ * @returns {string}
  */
-declare function toCoordinateFormat(format: any): any;
+declare function toCoordinateFormat(format: string): string;

package/dist/cjs/toCoordinateFormat.js

@@ -3,7 +3,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * Converts decimalCoordinates to other formats commonly used
- * @param {*} format Either DMS or DM
+ * @param {string} format Either DMS or DM
+ * @returns {string}
  */
 function toCoordinateFormat(format) {
     if (!['DMS', 'DM', 'DD'].includes(format))

package/dist/mjs/converter.d.ts

@@ -2,13 +2,21 @@ export default converter;
 /**
  * Function for converting coordinates in a variety of formats to decimal coordinates
  * @param {string} coordsString The coordinates string to convert
- * @param {number} decimalPlaces The number of decimal places for converted coordinates; default is 5
- * @returns {object} { verbatimCoordinates, decimalCoordinates, decimalLatitude, decimalLongitude }
+ * @param {number} [decimalPlaces] The number of decimal places for converted coordinates; default is 5
+ * @returns {{verbatimCoordinates: string, decimalCoordinates: string, decimalLatitude: string, decimalLongitude: string, closeEnough: function(string): boolean, toCoordinateFormat: toCoordinateFormat}}
  */
-declare function converter(coordsString: string, decimalPlaces: number): object;
+declare function converter(coordsString: string, decimalPlaces?: number | undefined): {
+    verbatimCoordinates: string;
+    decimalCoordinates: string;
+    decimalLatitude: string;
+    decimalLongitude: string;
+    closeEnough: (arg0: string) => boolean;
+    toCoordinateFormat: typeof toCoordinateFormat;
+};
 declare namespace converter {
     export { to };
 }
+import toCoordinateFormat from './toCoordinateFormat.js';
 declare const to: Readonly<{
     DMS: "DMS";
     DM: "DM";

package/dist/mjs/converter.js

@@ -5,8 +5,8 @@ import toCoordinateFormat from './toCoordinateFormat.js';
 /**
  * Function for converting coordinates in a variety of formats to decimal coordinates
  * @param {string} coordsString The coordinates string to convert
- * @param {number} decimalPlaces The number of decimal places for converted coordinates; default is 5
- * @returns {object} { verbatimCoordinates, decimalCoordinates, decimalLatitude, decimalLongitude }
+ * @param {number} [decimalPlaces] The number of decimal places for converted coordinates; default is 5
+ * @returns {{verbatimCoordinates: string, decimalCoordinates: string, decimalLatitude: string, decimalLongitude: string, closeEnough: function(string): boolean, toCoordinateFormat: toCoordinateFormat}}
  */
 function converter(coordsString, decimalPlaces) {
     //TODO add exact match to entered string, so that it can be used to filter out superflous text around it

package/dist/mjs/tests/testIndividual.js

@@ -1,7 +1,7 @@
 import convert from '../converter.js';
 //const test = '26°44S 29°46E'
 //const test = '00.00, 01.00'
-const test = `8°83S 35°67E`;
+const test = `26°05240'S, 27°51448'E`;
 try {
     let converted = convert(test);
     console.log(converted);

package/dist/mjs/toCoordinateFormat.d.ts

@@ -1,6 +1,7 @@
 export default toCoordinateFormat;
 /**
  * Converts decimalCoordinates to other formats commonly used
- * @param {*} format Either DMS or DM
+ * @param {string} format Either DMS or DM
+ * @returns {string}
  */
-declare function toCoordinateFormat(format: any): any;
+declare function toCoordinateFormat(format: string): string;

package/dist/mjs/toCoordinateFormat.js

@@ -1,7 +1,8 @@
 //borrowed from https://www.codegrepper.com/code-examples/javascript/javascript+converting+latitude+longitude+to+gps+coordinates
 /**
  * Converts decimalCoordinates to other formats commonly used
- * @param {*} format Either DMS or DM
+ * @param {string} format Either DMS or DM
+ * @returns {string}
  */
 function toCoordinateFormat(format) {
     if (!['DMS', 'DM', 'DD'].includes(format))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geo-coordinates-parser",
-  "version": "1.6.5",
+  "version": "1.6.6",
   "description": "A Javascript function for reading a variety of coordinate formats and converting to decimal numbers. Builds on other efforts by returning the verbatim coordinates and the decimal coordinates all in one object.",
   "type": "module",
   "main": "./dist/cjs/merge.js",