# Overview

version: 1.0.0

Simplified dictionary, works only with a global variable.

## Dictionary

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong><code>dictionary.get()</code></strong></td><td>returns global dictionary(if in use) along with a given <code>$dictionary</code> and/or <code>$key</code>.</td><td></td><td><a href="../translator-v0.1.0/dictionary/dictionary.get">dictionary.get</a></td></tr><tr><td><strong><code>dictionary.is-global()</code></strong></td><td>Checks whether the global dictionary is in use. </td><td></td><td><a href="../translator-v0.1.0/dictionary/dictionary.is-global">dictionary.is-global</a></td></tr><tr><td><strong><code>dictionary.merge()</code></strong></td><td>Merges the global dictionary(if in use) with multiple dictionaries from the given <code>$dictionary</code> in the <code>$key</code>.</td><td></td><td><a href="../translator-v0.1.0/dictionary/dictionary.merge">dictionary.merge</a></td></tr><tr><td><strong><code>dictionary.pick()</code></strong></td><td>Returns the dictionary from a global dictionary(if in use) and a given <code>$dictionary</code> from the associated <code>$key</code>.</td><td></td><td><a href="../translator-v0.1.0/dictionary/dictionary.pick">dictionary.pick</a></td></tr><tr><td><strong><code>dictionary.set()</code></strong></td><td>Sets the global dictionary and/or given <code>$dictionary</code> under the <code>$key</code> with <code>$value</code>.</td><td></td><td><a href="../translator-v0.1.0/dictionary/dictionary.set">dictionary.set</a></td></tr><tr><td><strong><code>dictionary.translation()</code></strong></td><td>Returns a translation of <code>$search</code> from <code>$dictionaries</code>.</td><td></td><td><a href="../translator-v0.1.0/dictionary/dictionary.translation">dictionary.translation</a></td></tr></tbody></table>

## Translate

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong><code>translate.list()</code></strong></td><td>Translates <code>$list</code> with a global dictionary and/or given <code>$dictionary</code>.</td><td></td><td><a href="../translator-v0.1.0/translate/translate.list">translate.list</a></td></tr><tr><td><strong><code>translate.map()</code></strong></td><td>Translates flatten <code>$map</code> with a global dictionary and/or <code>$dictionary</code>.</td><td></td><td><a href="../translator-v0.1.0/translate/translate.map">translate.map</a></td></tr><tr><td><strong><code>translate.nth()</code></strong></td><td>Translates element at <code>$n</code> index in <code>$list</code> with a global dictionary and/or <code>$dictionary</code>.</td><td></td><td><a href="../translator-v0.1.0/translate/translate.nth">translate.nth</a></td></tr><tr><td><strong><code>translate.string()</code></strong></td><td>returns a translation of the <code>$string</code>, if found, otherwise not translated <code>$string</code>.</td><td></td><td><a href="../translator-v0.1.0/translate/translate.string">translate.string</a></td></tr></tbody></table>

## Translator

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong><code>translator.dictionary()</code></strong></td><td>Returns(flattened map) the global and/or given <code>$dictionary</code>, merging it with the dictionary retrieved by the provided <code>$key</code> from this dictionary.</td><td></td><td><a href="../translator-v0.1.0/translator.dictionary">translator.dictionary</a></td></tr><tr><td><strong><code>translator.translate()</code></strong></td><td>Translates <code>string</code>, <code>map</code>, or <code>list</code> with a global dictionary and/or given <code>$dictionary</code>, optionally with a dictionary retrieved by the given <code>$key</code>.</td><td></td><td><a href="../translator-v0.1.0/translator.translate">translator.translate</a></td></tr></tbody></table>
