> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qu.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# WordlistOwl

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

* [`Wordlist`](/sdk/content/classes/Wordlist)

## Extended by

* [`LangEn`](/sdk/content/classes/LangEn)
* [`WordlistOwlA`](/sdk/content/classes/WordlistOwlA)

## Constructors

### new WordlistOwl()

```ts theme={null}
new WordlistOwl(
   locale, 
   data, 
   checksum): WordlistOwl
```

Creates a new Wordlist for `locale` using the OWL `data` and validated against the `checksum`.

#### Parameters

| Parameter  | Type     |
| :--------- | :------- |
| `locale`   | `string` |
| `data`     | `string` |
| `checksum` | `string` |

#### Returns

[`WordlistOwl`](/sdk/content/classes/WordlistOwl)

#### Overrides

[`Wordlist`](/sdk/content/classes/Wordlist).[`constructor`](/sdk/content/classes/Wordlist#constructors)

#### Source

[wordlists/wordlist-owl.ts:28](https://github.com/dominant-strategies/quais.js/blob/c1c12d43f9d34c6baad2b0542bd6d0acd6fefcbf/src/wordlists/wordlist-owl.ts#L28)

## Methods

### \_decodeWords()

```ts theme={null}
_decodeWords(): string[]
```

Decode all the words for the wordlist.

#### Returns

`string`\[]

#### Source

[wordlists/wordlist-owl.ts:47](https://github.com/dominant-strategies/quais.js/blob/c1c12d43f9d34c6baad2b0542bd6d0acd6fefcbf/src/wordlists/wordlist-owl.ts#L47)

***

### join()

```ts theme={null}
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

| Parameter | Type        | Description        |
| :-------- | :---------- | :----------------- |
| `words`   | `string`\[] | The words to join. |

#### Returns

`string`

The joined phrase.

#### Inherited from

[`Wordlist`](/sdk/content/classes/Wordlist).[`join`](/sdk/content/classes/Wordlist#join)

#### Source

[wordlists/wordlist.ts:45](https://github.com/dominant-strategies/quais.js/blob/c1c12d43f9d34c6baad2b0542bd6d0acd6fefcbf/src/wordlists/wordlist.ts#L45)

***

### split()

```ts theme={null}
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

| Parameter | Type     | Description          |
| :-------- | :------- | :------------------- |
| `phrase`  | `string` | The phrase to split. |

#### Returns

`string`\[]

The split words in the phrase.

#### Inherited from

[`Wordlist`](/sdk/content/classes/Wordlist).[`split`](/sdk/content/classes/Wordlist#split)

#### Source

[wordlists/wordlist.ts:33](https://github.com/dominant-strategies/quais.js/blob/c1c12d43f9d34c6baad2b0542bd6d0acd6fefcbf/src/wordlists/wordlist.ts#L33)