A Wordlist represents a collection of language-specific words used to encode and devoce BIP-39 encoded data by mapping words to 11-bit values and vice versa.

​
Extended by

​
Constructors

​
new Wordlist()

new Wordlist(locale): Wordlist
Creates a new Wordlist instance. Sub-classes MUST call this if they provide their own constructor, passing in the locale string of the language. Generally there is no need to create instances of a Wordlist, since each language-specific Wordlist creates an instance and there is no state kept internally, so they are safe to share.

​
Parameters

ParameterType
localestring

​
Returns

Wordlist

​
Source

wordlists/wordlist.ts:20

​
Methods

​
getWord()

abstract getWord(index): string
Maps an 11-bit value into its coresponding word in the list. Sub-classes MUST override this.

​
Parameters

ParameterType
indexnumber

​
Returns

string

​
Source

wordlists/wordlist.ts:54

​
getWordIndex()

abstract getWordIndex(word): number
Maps a word to its corresponding 11-bit value. Sub-classes MUST override this.

​
Parameters

ParameterType
wordstring

​
Returns

number

​
Source

wordlists/wordlist.ts:61

​
join()

join(words): string
Sub-classes may override this to provider a language-specific method for joining words into a phrase. By default, words are joined by a single space.

​
Parameters

ParameterTypeDescription
wordsstring[]The words to join.

​
Returns

string The joined phrase.

​
Source

wordlists/wordlist.ts:45

​
split()

split(phrase): string[]
Sub-classes may override this to provide a language-specific method for spliting phrase into individual words. By default, phrase is split using any sequences of white-space as defined by regular expressions (i.e. /\s+/).

​
Parameters

ParameterTypeDescription
phrasestringThe phrase to split.

​
Returns

string[] The split words in the phrase.

​
Source

wordlists/wordlist.ts:33