# bigstring

> BigString is a very short and simple library to make text big!

Latest version **1.0.0** (published 2022-10-08) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-10-08 |
| First published | 2022-10-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 22.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | lukas0008 |
| Maintainers | lukas0008 |

## Links

- npm: https://www.npmjs.com/package/bigstring
- npm.io page: https://npm.io/package/bigstring

## Recent versions

- 1.0.0 (latest) — 2022-10-08

## README

# BigString

BigString is a very short and simple library to make text big!

F.e `HELLO!` to:

```
█   █ ██████ █     █      █████  ██
█   █ █      █     █     █     █ ██
█████ █████  █     █     █     █ ██
█   █ █      █     █     █     █
█   █ ██████ █████ █████  █████  ██
```

Currently only one font (LargeFontCaps) is inside of this module but you can easily make more by just constructing the `BigFont` class.

## Usage

To use the LargeFontCaps font which only has characters from A-Z 1-9 and !, just do:

```ts
import { LargeFontCaps } from "BigString";

const myMessage = LargeFontCaps.getTextFromFont("HELLO WORLD!");

console.log(myMessage);
```

I Mentioned before a way to make your own fonts though. You can do it following the structure below:

```ts
import { BigFont } from "BigString";

const MyFont = new BigFont({
  break: new Array(5).fill(" ");
  A: [
    "  ██  ",
    " █  █ ",
    "██████",
    "█    █",
    "█    █",
  ],
  ...
  ...
});
```

Here I just set break to an array of spaces to add a simple space between the letters.

> :warning: **All element in the object must be singular characters**: with one exception, `break`. Its used to determine what should be between the characters.

> :warning: **All the strings in the string array must be the same length**

If you'd like an example of a font, look inside [`src/fonts.ts`](https://github.com/lukas0008/BigString/blob/main/src/fonts.ts) to see how the LargeFontCaps font was created.

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