mirror of
https://github.com/garraflavatra/alphabets.git
synced 2024-11-22 10:27:36 +01:00
A collection of many different alphabets for many different use cases.
.husky | ||
docs | ||
src | ||
.gitignore | ||
.npmignore | ||
LICENSE.md | ||
package-lock.json | ||
package.json | ||
README.md | ||
rollup.config.js |
Alphabets
A tiny JS dependency (<800 bytes!) which exports many alphabets for many use cases.
For more: see the Alphabets 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 |
---|---|
Latin | latin |
Greek (modern) | greek |
Greek (ancient/polytonic) | greekPolytonic |