# alphabetjs

> ```

Latest version **0.1.4** (published 2017-12-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install alphabetjs
pnpm add alphabetjs
yarn add alphabetjs
bun add alphabetjs
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2017-12-28 |
| First published | 2015-08-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | starkwang |
| Maintainers | starkwang |

## Links

- npm: https://www.npmjs.com/package/alphabetjs
- Repository: https://github.com/starkawng/alphabetJS
- Homepage: https://github.com/starkwang/alphabetJS
- Issues: https://github.com/starkawng/alphabetJS/issues
- npm.io page: https://npm.io/package/alphabetjs

## Recent versions

- 0.1.4 (latest) — 2017-12-28
- 0.1.3 — 2015-09-07
- 0.1.2 — 2015-09-04
- 0.1.1 — 2015-09-04
- 0.1.0 — 2015-09-04
- 0.0.3 — 2015-08-31
- 0.0.2 — 2015-08-31
- 0.0.1 — 2015-08-31

## README

```

     /\     |ˉ|         |ˉˉˉˉˉˉˉˉˉ\ |ˉ|      |ˉ|     /\     |ˉˉˉˉˉˉˉˉˉ\ |ˉˉˉˉˉˉˉˉˉˉ||ˉˉˉˉˉˉˉˉˉˉˉ|
    /  \    | |         | |ˉˉˉˉˉˉ\ \| |      | |    /  \    | |ˉˉˉˉˉ\ | | |ˉˉˉˉˉˉˉˉ  ˉˉˉˉ| |ˉˉˉˉ 
   / /\ \   | |         | |      | ||  ˉˉˉˉˉˉ  |   / /\ \   |  ˉˉˉˉˉ  / |  ˉˉˉˉˉˉˉˉ|     | |     
  / /  \ \  | |         | ˉˉˉˉˉˉˉ  /| |ˉˉˉˉˉˉ| |  / /  \ \  | |ˉˉˉˉˉ\ \ | |ˉˉˉˉˉˉˉˉ      | |     
 /  ˉˉˉˉ  \ | |         | |ˉˉˉˉˉˉˉˉ | |      | | /  ˉˉˉˉ  \ | |     /  || |              | |     
/ /ˉˉˉˉˉˉ\ \|  ˉˉˉˉˉˉˉˉ|| |         | |      | |/ /ˉˉˉˉˉˉ\ \|  ˉˉˉˉˉ  / |  ˉˉˉˉˉˉˉˉ|     | |     
ˉˉ        ˉˉ ˉˉˉˉˉˉˉˉˉˉ ˉˉˉ          ˉ        ˉ ˉˉ        ˉˉ ˉˉˉˉˉˉˉˉˉ   ˉˉˉˉˉˉˉˉˉˉ      ˉˉˉ     

```

# AlphabetJS

AlphabetJS is a small tool to help you output big English character in console/shell or anyother platform.

------

# Usage  

Use `npm` to install it 

```
npm install alphabetjs --save
```
Then you can require it in node:

```js
const Alphabet = require('alphabetjs');
```
Then you can use it to print character in shell:

```js
const str = Alphabet('KOBE24','planar')
console.log(str);
```

And then you get:

```
|ˉ|    /ˉ/  /ˉˉˉˉˉˉˉˉ\ |ˉˉˉˉˉˉˉˉˉ\ |ˉˉˉˉˉˉˉˉˉˉ| /ˉˉˉˉˉˉˉˉ\     /ˉˉˉ|   
| |   / /  / /ˉˉˉˉˉˉ\ \| |ˉˉˉˉˉ\ | | |ˉˉˉˉˉˉˉˉ / /ˉˉˉˉˉˉ\ \   / /| |   
|  ˉˉˉ |   | |      | ||  ˉˉˉˉˉ  / |  ˉˉˉˉˉˉˉˉ|ˉˉ       / /  / / | |   
| |ˉˉˉ\ \  | |      | || |ˉˉˉˉˉ\ \ | |ˉˉˉˉˉˉˉˉ |ˉˉˉˉˉˉˉˉ /  / /  | |   
| |    \ \ \ \      / /| |     /  || |         | |ˉˉˉˉˉˉˉ  |  ˉˉˉˉ ˉˉˉ|
| |     \ \ \ ˉˉˉˉˉˉ / |  ˉˉˉˉˉ  / |  ˉˉˉˉˉˉˉˉ||  ˉˉˉˉˉˉˉˉ| ˉˉˉˉˉ| |ˉˉ 
 ˉ       ˉ   ˉˉˉˉˉˉˉˉ   ˉˉˉˉˉˉˉˉˉ   ˉˉˉˉˉˉˉˉˉˉ  ˉˉˉˉˉˉˉˉˉˉ       ˉˉˉ 

```


--------------
# API

### Alphabet(str,character_type);

`@param {string} str` : `capital letter` or `number`, the string you want to output.

`@param {string} character_type` : `'planar'` or `'stereo'` , the style of the character

----------
# License

The MIT License (MIT)

Copyright (c) Weijia Wang <starkwang@126.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

---
_Source: https://npm.io/package/alphabetjs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._