# ascii-art-font

> ``` _ _ _ (_)(_) | | __ _ ___ ___ _ _ ______ __ _ _ __ | |_ / _` |/ __| / __|| || ||______| / _` || '__|| __| | (_| |\__ \| (__ | || | | (_| || | | |_ \_

Latest version **1.0.2** (published 2019-12-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install ascii-art-font
pnpm add ascii-art-font
yarn add ascii-art-font
bun add ascii-art-font
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2019-12-07 |
| First published | 2019-08-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 22.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Abbey Hawk Sparrow |
| Maintainers | khrome |
| Keywords | ascii, figlet, font, ansi, terminal, text, command-line, xterm, shell, formatting, tty, str, string, cli, console, terminal |

## Links

- npm: https://www.npmjs.com/package/ascii-art-font
- Repository: https://github.com/khrome/ascii-art-font
- Homepage: https://github.com/khrome/ascii-art-font#readme
- Issues: https://github.com/khrome/ascii-art-font/issues
- npm.io page: https://npm.io/package/ascii-art-font

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2019-12-07
- 1.0.1 — 2019-11-04
- 1.0.0 — 2019-10-28
- 0.0.3 — 2019-10-28
- 0.0.2 — 2019-08-18
- 0.0.1 — 2019-08-16

## README

```
                   _  _                       _
                  (_)(_)                     | |
  __ _  ___   ___  _  _  ______   __ _  _ __ | |_
 / _` |/ __| / __|| || ||______| / _` || '__|| __|
| (_| |\__ \| (__ | || |        | (_| || |   | |_
 \__,_||___/ \___||_||_|         \__,_||_|    \__|
 ```

ascii-art-font.js
=================

[![NPM version](https://img.shields.io/npm/v/ascii-art-table.svg)]()
[![npm](https://img.shields.io/npm/dt/ascii-art-table.svg)]()
[![Travis](https://img.shields.io/travis/khrome/ascii-art-table.svg)]()

This module handles the installation, rendering and management of figlet fonts.

Figlet fonts are an ASCII art font standard, widely used for terminal output.

It looks something like this:

    ______                          _
    |  _  \                        | |
    | | | |  ___  _ __ ___    ___  | |
    | | | | / _ \| '_ ` _ \  / _ \ | |
    | |/ / |  __/| | | | | || (_) ||_|
    |___/   \___||_| |_| |_| \___/ (_)


Installation
------------

    npm install ascii-art-table


Usage
------

<a name="module_ascii_art_font"></a>
### require('ascii-art-font')
To do anything with it, you'll need to include the library:

```javascript
const Font = require('ascii-art-font');
```

* [ascii-art-font](#module_ascii_art_font)
    * [Font.create(string, font, handler)](#module_ascii_art_font.create) ⇒ Promise (if no callback)


<a name="module_ascii_art_font.create"></a>
### Font.create(text, styles, handler)
Map through an ansi string one character at a time, without any of those characters being styles.

**Kind**: static property of <code>[ascii-art-font](#ascii-art-ansi)</code>

| Param | Type | Description |
| --- | --- | --- |
| text | <code>string</code> | the string to render in block form |
| styles | <code>string</code> | the styles to apply to all lines |
| callback | <code>function(err, result)</code> | the callback |

**Example**

    To set the directory of the fonts:

        Font.fontPath = 'Fonts';

    Then to render some text:

        Font.create('my text', 'Doom', function(rendered){
            //do stuff here
        });

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