UNPKG

1.04 kBTypeScriptView Raw
1import { Wordlist } from "./wordlist.js";
2/**
3 * An OWL format Wordlist is an encoding method that exploits
4 * the general locality of alphabetically sorted words to
5 * achieve a simple but effective means of compression.
6 *
7 * This class is generally not useful to most developers as
8 * it is used mainly internally to keep Wordlists for languages
9 * based on ASCII-7 small.
10 *
11 * If necessary, there are tools within the ``generation/`` folder
12 * to create the necessary data.
13 */
14export declare class WordlistOwl extends Wordlist {
15 #private;
16 /**
17 * Creates a new Wordlist for %%locale%% using the OWL %%data%%
18 * and validated against the %%checksum%%.
19 */
20 constructor(locale: string, data: string, checksum: string);
21 /**
22 * The OWL-encoded data.
23 */
24 get _data(): string;
25 /**
26 * Decode all the words for the wordlist.
27 */
28 _decodeWords(): Array<string>;
29 getWord(index: number): string;
30 getWordIndex(word: string): number;
31}
32//# sourceMappingURL=wordlist-owl.d.ts.map
\No newline at end of file