@pranamphd/digipin 0.1.0-alpha.1 → 0.1.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -36,6 +36,54 @@ All implementations in this repository aim to faithfully reproduce the behavior
36
36
 
37
37
  ---
38
38
 
39
+ ## Usage
40
+
41
+ ```sh
42
+ npm i @pranamphd/digipin
43
+ ```
44
+ ### TypeScript
45
+
46
+ ```ts
47
+ import { encode, decode, Location } from "@pranamphd/digipin";
48
+
49
+ const location: Location = { latitude: 28.6139, longitude: 77.209 }; // Example coordinates for Kartavya Path, New Delhi
50
+
51
+ const digipin = encode(location); // Encode coordinates to DIGIPIN
52
+ console.log(digipin); // Example output: "39J438TJC7"
53
+
54
+ const decodedLocation = decode(digipin); // Decode DIGIPIN back to coordinates
55
+ console.log(decodedLocation); // Example output: { latitude: 28.6139, longitude: 77.209 }
56
+ ```
57
+ ### JavaScript (CommonJS)
58
+
59
+ ```js
60
+ const {encode, decode} = require("@pranamphd/digipin");
61
+
62
+ let location = { latitude: 28.6139, longitude: 77.209 }; // Example coordinates for Kartavya Path, New Delhi
63
+
64
+ let digipin = encode(location); // Encode coordinates to DIGIPIN
65
+ console.log(digipin); // Example output: "39J438TJC7"
66
+
67
+ let decodedLocation = decode(digipin); // Decode DIGIPIN back to coordinates
68
+ console.log(decodedLocation); // Example output: { latitude: 28.6139, longitude: 77.209 }
69
+ ```
70
+
71
+ ### JavaScript (ESM)
72
+
73
+ ```js
74
+ import { encode, decode } from "@pranamphd/digipin";
75
+
76
+ let location = { latitude: 28.6139, longitude: 77.209 }; // Example coordinates for Kartavya Path, New Delhi
77
+
78
+ let digipin = encode(location); // Encode coordinates to DIGIPIN
79
+ console.log(digipin); // Example output: "39J438TJC7"
80
+
81
+ let decodedLocation = decode(digipin); // Decode DIGIPIN back to coordinates
82
+ console.log(decodedLocation); // Example output: { latitude: 28.6139, longitude: 77.209 }
83
+ ```
84
+
85
+ ---
86
+
39
87
  ## Status
40
88
 
41
89
  This repository is under active development.
package/dist/index.d.ts CHANGED
@@ -23,13 +23,39 @@
23
23
  *
24
24
  * @example
25
25
  * ```ts
26
+ * import { encode, decode, Location } from "@pranamphd/digipin";
27
+ *
28
+ * const location: Location = { latitude: 28.6139, longitude: 77.209 }; // Example coordinates for Kartavya Path, New Delhi
29
+ *
30
+ * const digipin = encode(location); // Encode coordinates to DIGIPIN
31
+ * console.log(digipin); // Example output: "39J438TJC7"
32
+ *
33
+ * const decodedLocation = decode(digipin); // Decode DIGIPIN back to coordinates
34
+ * console.log(decodedLocation); // Example output: { latitude: 28.6139, longitude: 77.209 }
35
+ * ```
36
+ *
37
+ * ```js
38
+ * const {encode, decode} = require("@pranamphd/digipin");
39
+ *
40
+ * let location = { latitude: 28.6139, longitude: 77.209 }; // Example coordinates for Kartavya Path, New Delhi
41
+ *
42
+ * let digipin = encode(location); // Encode coordinates to DIGIPIN
43
+ * console.log(digipin); // Example output: "39J438TJC7"
44
+ *
45
+ * let decodedLocation = decode(digipin); // Decode DIGIPIN back to coordinates
46
+ * console.log(decodedLocation); // Example output: { latitude: 28.6139, longitude: 77.209 }
47
+ * ```
48
+ *
49
+ * ```js
26
50
  * import { encode, decode } from "@pranamphd/digipin";
27
51
  *
28
- * const digipin = encode(28.6139, 77.209); // Encode coordinates to DIGIPIN
52
+ * let location = { latitude: 28.6139, longitude: 77.209 }; // Example coordinates for Kartavya Path, New Delhi
53
+ *
54
+ * let digipin = encode(location); // Encode coordinates to DIGIPIN
29
55
  * console.log(digipin); // Example output: "39J438TJC7"
30
56
  *
31
- * const location = decode(digipin); // Decode DIGIPIN back to coordinates
32
- * console.log(location); // Example output: { latitude: 28.6139, longitude: 77.209 }
57
+ * let decodedLocation = decode(digipin); // Decode DIGIPIN back to coordinates
58
+ * console.log(decodedLocation); // Example output: { latitude: 28.6139, longitude: 77.209 }
33
59
  * ```
34
60
  */
35
61
  export { encode } from "./encode.js";
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,YAAY,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,YAAY,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC"}
package/dist/index.js CHANGED
@@ -23,13 +23,39 @@
23
23
  *
24
24
  * @example
25
25
  * ```ts
26
+ * import { encode, decode, Location } from "@pranamphd/digipin";
27
+ *
28
+ * const location: Location = { latitude: 28.6139, longitude: 77.209 }; // Example coordinates for Kartavya Path, New Delhi
29
+ *
30
+ * const digipin = encode(location); // Encode coordinates to DIGIPIN
31
+ * console.log(digipin); // Example output: "39J438TJC7"
32
+ *
33
+ * const decodedLocation = decode(digipin); // Decode DIGIPIN back to coordinates
34
+ * console.log(decodedLocation); // Example output: { latitude: 28.6139, longitude: 77.209 }
35
+ * ```
36
+ *
37
+ * ```js
38
+ * const {encode, decode} = require("@pranamphd/digipin");
39
+ *
40
+ * let location = { latitude: 28.6139, longitude: 77.209 }; // Example coordinates for Kartavya Path, New Delhi
41
+ *
42
+ * let digipin = encode(location); // Encode coordinates to DIGIPIN
43
+ * console.log(digipin); // Example output: "39J438TJC7"
44
+ *
45
+ * let decodedLocation = decode(digipin); // Decode DIGIPIN back to coordinates
46
+ * console.log(decodedLocation); // Example output: { latitude: 28.6139, longitude: 77.209 }
47
+ * ```
48
+ *
49
+ * ```js
26
50
  * import { encode, decode } from "@pranamphd/digipin";
27
51
  *
28
- * const digipin = encode(28.6139, 77.209); // Encode coordinates to DIGIPIN
52
+ * let location = { latitude: 28.6139, longitude: 77.209 }; // Example coordinates for Kartavya Path, New Delhi
53
+ *
54
+ * let digipin = encode(location); // Encode coordinates to DIGIPIN
29
55
  * console.log(digipin); // Example output: "39J438TJC7"
30
56
  *
31
- * const location = decode(digipin); // Decode DIGIPIN back to coordinates
32
- * console.log(location); // Example output: { latitude: 28.6139, longitude: 77.209 }
57
+ * let decodedLocation = decode(digipin); // Decode DIGIPIN back to coordinates
58
+ * console.log(decodedLocation); // Example output: { latitude: 28.6139, longitude: 77.209 }
33
59
  * ```
34
60
  */
35
61
  export { encode } from "./encode.js";
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pranamphd/digipin",
3
- "version": "0.1.0-alpha.1",
3
+ "version": "0.1.0-alpha.2",
4
4
  "description": "TypeScript library for encoding and decoding India's DIGIPIN (Digital Postal Index Number).",
5
5
  "keywords": [
6
6
  "digipin",