1
0
mirror of https://github.com/garraflavatra/alphabets.git synced 2024-11-24 01:17:28 +01:00
alphabets/README.md
2021-07-15 11:07:54 +02:00

2.3 KiB

Alphabets

CI npm npm bundle size GitHub last commit Forum

A tiny JS dependency (<2kb!) which exports many alphabets for many use cases.

More information is available in the documentation.

Why would I use this?

Why?

I have seen developers doing 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, it makes your code less readable (read: ugly) and it's simply not something you should want to have in your code! Instead, you should do it like so:

import { latin } from 'alphabets';
// or
const alphabets = require('alphabets');

Much cleaner, right? That's why I made this package.

Installation

Use npm:

npm install alphabets --save

Or if you prefer Yarn:

yarn add alphabets

CDN, if that's more your style:

<script src="https://unpkg.com/alphabet@1/dist/bundle.js"></script>

Usage

import { <alphabetYouWantToUse> } from 'alphabets';

or:

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

where <alphabetYouWantToUse> is an alphabet this package supports. Here is a list from which you can choose.

Supported alphabets

Usage: see Usage.

Name Export name
Danish danish
Faroese faroese
Greek (modern) greek
Greek (ancient/polytonic) greekPolytonic
Icelandic icelandic
Latin latin
Norwegian norwegian
Russian russian
Swedish swedish