1
0
mirror of https://github.com/garraflavatra/alphabets.git synced 2024-11-27 22:26:24 +01:00
alphabets/README.md
2024-08-06 14:26:49 +02:00

3.8 KiB

Alphabets

A tiny JS package that exports many different alphabets for many different use cases.

npm Stand With Ukraine

Included alphabets

See below for usage instructions.

Export name Alphabet
danish Danish, same as Norwegian
faroese Faroese
greek Greek
icelandic Icelandic
latin Latin (abcdefg etc.)
nato NATO phonetic alphabet
norwegian Norwegian, same as Danish
polish Polish
russian Russian
swedish Swedish
ukrainian Ukrainian

Installation

Install the alphabets npm module using your preferred package manager:

  • npm: npm install alphabets
  • Yarn: yarn add alphabets
  • pnpm: pnpm add alphabets

You can also use it with Deno by importing https://deno.land/x/alphabets/alphabets.mjs.

How to use

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

import { <alphabetYouWantToUse> } from 'alphabets';

Deno:

import { <alphabetYouWantToUse> } from 'https://deno.land/x/alphabets/alphabets.mjs';

or:

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

Why

I have seen code like this:

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

Or even 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';

for (const glyph of latin) {/* ... */}

This is much cleaner and more idiomatic.

Questions and bugs

Did you find a mistake in an alphabet, or another bug? Please report it — thank you! I'll try to fix it as soon as possible.

You may use the same issue form for questions, too.

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

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

Smart Yellow