An OWL format Wordlist is an encoding method that exploits the general locality of alphabetically sorted words to achieve a simple but effective means of compression. This class is generally not useful to most developers as it is used mainly internally to keep Wordlists for languages based on ASCII-7 small. If necessary, there are tools within the generation/ folder to create the necessary data.

​
Extends

​
Extended by

​
Constructors

​
new WordlistOwl()

new WordlistOwl(
   locale, 
   data, 
   checksum): WordlistOwl
Creates a new Wordlist for locale using the OWL data and validated against the checksum.

​
Parameters

ParameterType
localestring
datastring
checksumstring

​
Returns

WordlistOwl

​
Overrides

Wordlist.constructor

​
Source

wordlists/wordlist-owl.ts:28

​
Methods

​
_decodeWords()

_decodeWords(): string[]
Decode all the words for the wordlist.

​
Returns

string[]

​
Source

wordlists/wordlist-owl.ts:47

​
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.

​
Inherited from

Wordlist.join

​
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.

​
Inherited from

Wordlist.split

​
Source

wordlists/wordlist.ts:33