docs.md

geowords

geowords

Table of contents

Interfaces

• Location

Functions

• decodeLocation
• decodeNumber
• encodeLocation
• encodeNumber

Functions

decodeLocation

▸ decodeLocation(inputWords, dict?): Location

Parameters

Name	Type	Default value
inputWords	string[]	undefined
dict	string[]	words

Returns

Location

Defined in

geowords/src/index.ts:37

---

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

---

encodeLocation

▸ encodeLocation(__namedParameters, wordsCount?, dict?): string[]

Parameters

Name	Type	Default value
__namedParameters	Location	undefined
wordsCount	number	3
dict	string[]	words

Returns

string[]

Defined in

geowords/src/index.ts:30

---

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

Interfaces

geowords / Location

Interface: Location

Table of contents

Properties

• lat
• lon

Properties

lat

• lat: number

Defined in

geonumber/lib/index.d.ts:6

---

lon

• lon: number

Defined in

geonumber/lib/index.d.ts:7