mirror of
https://github.com/garraflavatra/alphabets.git
synced 2024-11-27 22:26:24 +01:00
75 lines
1.8 KiB
Markdown
75 lines
1.8 KiB
Markdown
# Alphabets
|
|
|
|
A tiny JS dependency which exports many alphabets for many use cases.
|
|
|
|
[](https://www.npmjs.com/package/alphabets)
|
|
[](https://stand-with-ukraine.pp.ua)
|
|
|
|
## Why
|
|
|
|
I have seen code like this:
|
|
|
|
```js
|
|
const alphabet = 'abcdefghijklmnopqrstuvwxyz'.split('');
|
|
```
|
|
|
|
Or worse:
|
|
|
|
```js
|
|
const alphabet = ["a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z"];
|
|
```
|
|
|
|
My opinion about this: it's ugly, and it pollutes your code. Instead, you should do it like so:
|
|
|
|
```js
|
|
import { latin } from 'alphabets';
|
|
// or
|
|
const alphabets = require('alphabets');
|
|
|
|
doSomethingWithTheAlphabet(latin);
|
|
```
|
|
|
|
Much cleaner, right?
|
|
|
|
## Installation
|
|
|
|
Use npm: [`npm i alphabets`](https://www.npmjs.com/package/alphabets). Or if you prefer Yarn: `yarn add alphabets`.
|
|
|
|
## Supported alphabets
|
|
|
|
See below for usage instructions.
|
|
|
|
| Alphabet | Export name |
|
|
|------|-------------|
|
|
| Danish | `danish` |
|
|
| Faroese | `faroese` |
|
|
| Greek (modern) | `greek` |
|
|
| Greek (ancient/polytonic) | `greekPolytonic` |
|
|
| Icelandic | `icelandic` |
|
|
| Latin (abcdefg etc.) | `latin` |
|
|
| Norwegian | `norwegian` |
|
|
| Russian | `russian` |
|
|
| Swedish | `swedish` |
|
|
| Ukrainian | `ukrainian` |
|
|
|
|
## How to use
|
|
|
|
Replace `<alphabetYouWantToUse>` with an alphabet identifier this package supports:
|
|
|
|
```js
|
|
import { <alphabetYouWantToUse> } from 'alphabets';
|
|
```
|
|
|
|
or:
|
|
|
|
```js
|
|
const alphabets = require('alphabets');
|
|
console.log(alphabets.<alphabetYouWantToUse>);
|
|
```
|
|
|
|
## Copyright
|
|
|
|
(c) 2021-2023 Romein van Buren. Licensed under the MIT license.
|
|
|
|
For the full copyright and license information, please view the [`license.md`](./license.md) file that was distributed with this source code.
|