1
0
mirror of https://github.com/garraflavatra/alphabets.git synced 2024-11-21 22:59:03 +01:00
alphabets/README.md

2.8 KiB

Alphabets

A tiny JS dependency which exports many alphabets for many use cases.

npm Stand With Ukraine

Why

I have seen code like this:

const alphabet = 'abcdefghijklmnopqrstuvwxyz'.split('');

Or worse:

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, why not do it like this:

import { latin } from 'alphabets';

doSomethingWithTheAlphabet(latin);

Much cleaner, right?

Installation

Install the alphabets npm module using your preferred package manager:

  • npm: npm install alphabets
  • Yarn: yarn add alphabets
  • pnpm: pnpm 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
NATO phonetic alphabet nato
Norwegian norwegian
Russian russian
Swedish swedish
Ukrainian ukrainian

How to use

Replace <alphabetYouWantToUse> with an alphabet identifier this package supports:

import { <alphabetYouWantToUse> } from 'alphabets';

or:

const alphabets = require('alphabets');
console.log(alphabets.<alphabetYouWantToUse>);

(c) 2021-2023 Romein van Buren. Licensed under the MIT license.

For the full copyright and license information, please view the LICENSE.md file that was distributed with this source code.