UNPKG

geowords

Version:

Tool for encoding geographic coordinates as sequence of words from bip39 or other dictionary

github.com/MLaszczewski/geowords

MLaszczewski/geowords

142 lines (79 loc) • 2.42 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
<a name="readmemd"></a> geowords # geowords ## Table of contents ### Interfaces - [Location](#interfaceslocationmd) ### Functions - [decodeLocation](#decodelocation) - [decodeNumber](#decodenumber) - [encodeLocation](#encodelocation) - [encodeNumber](#encodenumber) ## Functions ### decodeLocation ▸ **decodeLocation**(`inputWords`, `dict?`): [`Location`](#interfaceslocationmd) #### Parameters | Name | Type | Default value | | :------ | :------ | :------ | | `inputWords` | `string`[] | `undefined` | | `dict` | `string`[] | `words` | #### Returns [`Location`](#interfaceslocationmd) #### Defined in [geowords/src/index.ts:37](https://github.com/MLaszczewski/geowords/blob/45e65ed/packages/geowords/src/index.ts#L37) ___ ### decodeNumber ▸ **decodeNumber**(`inputWords`, `dict?`): `bigint` #### Parameters | Name | Type | Default value | | :------ | :------ | :------ | | `inputWords` | `string`[] | `undefined` | | `dict` | `string`[] | `words` | #### Returns `bigint` #### Defined in [geowords/src/index.ts:20](https://github.com/MLaszczewski/geowords/blob/45e65ed/packages/geowords/src/index.ts#L20) ___ ### encodeLocation ▸ **encodeLocation**(`__namedParameters`, `wordsCount?`, `dict?`): `string`[] #### Parameters | Name | Type | Default value | | :------ | :------ | :------ | | `__namedParameters` | [`Location`](#interfaceslocationmd) | `undefined` | | `wordsCount` | `number` | `3` | | `dict` | `string`[] | `words` | #### Returns `string`[] #### Defined in [geowords/src/index.ts:30](https://github.com/MLaszczewski/geowords/blob/45e65ed/packages/geowords/src/index.ts#L30) ___ ### encodeNumber ▸ **encodeNumber**(`number`, `wordsCount?`, `dict?`): `string`[] #### Parameters | Name | Type | Default value | | :------ | :------ | :------ | | `number` | `bigint` | `undefined` | | `wordsCount` | `number` | `3` | | `dict` | `string`[] | `words` | #### Returns `string`[] #### Defined in [geowords/src/index.ts:9](https://github.com/MLaszczewski/geowords/blob/45e65ed/packages/geowords/src/index.ts#L9) # Interfaces <a name="interfaceslocationmd"></a> [geowords](#readmemd) / Location # Interface: Location ## Table of contents ### Properties - [lat](#lat) - [lon](#lon) ## Properties ### lat • **lat**: `number` #### Defined in geonumber/lib/index.d.ts:6 ___ ### lon • **lon**: `number` #### Defined in geonumber/lib/index.d.ts:7