Logo for jsDocs.io

figlet

  • Version 1.9.3
  • Published
  • 18.5 MB
  • 1 dependency
  • MIT license

Install

npm i figlet
yarn add figlet
pnpm add figlet

Overview

Creates ASCII Art from text. A full implementation of the FIGfont spec.

Index

Variables

Interfaces

Type Aliases

Variables

variable figlet

const figlet: FigletModule;

    Interfaces

    interface FigletDefaults

    interface FigletDefaults {}

      property fetchFontIfMissing

      fetchFontIfMissing: boolean;

        property font

        font: FontName;

          property fontPath

          fontPath: string;

            interface FigletOptions

            interface FigletOptions {}

              property font

              font?: FontName;

                property horizontalLayout

                horizontalLayout?: KerningMethods;

                  property printDirection

                  printDirection?: PrintDirection;

                    property showHardBlanks

                    showHardBlanks?: boolean;

                      property verticalLayout

                      verticalLayout?: KerningMethods;

                        property whitespaceBreak

                        whitespaceBreak?: boolean;

                          property width

                          width?: number;

                            interface FontMetadata

                            interface FontMetadata {}

                              property baseline

                              baseline?: number;

                                property codeTagCount

                                codeTagCount?: number | null;

                                  property fittingRules

                                  fittingRules: FittingRules;

                                    property fullLayout

                                    fullLayout?: number | null;

                                      property hardBlank

                                      hardBlank?: string;

                                        property height

                                        height?: number;

                                          property maxLength

                                          maxLength?: number;

                                            property numCommentLines

                                            numCommentLines?: number;

                                              property oldLayout

                                              oldLayout?: number;

                                                property printDirection

                                                printDirection?: PrintDirection;

                                                  Type Aliases

                                                  type CallbackFunction

                                                  type CallbackFunction<T = string> = (error: Error | null, result?: T) => void;

                                                    type FontName

                                                    type FontName =
                                                        | '1Row'
                                                        | '3-D'
                                                        | '3D Diagonal'
                                                        | '3D-ASCII'
                                                        | '3x5'
                                                        | '4Max'
                                                        | '5 Line Oblique'
                                                        | 'Standard'
                                                        | 'Ghost'
                                                        | 'Big'
                                                        | 'Block'
                                                        | 'Bubble'
                                                        | 'Digital'
                                                        | 'Ivrit'
                                                        | 'Mini'
                                                        | 'Script'
                                                        | 'Shadow'
                                                        | 'Slant'
                                                        | 'Small'
                                                        | 'Speed'
                                                        | 'Tinker-Toy'
                                                        | string;

                                                      Package Files (1)

                                                      Dependencies (1)

                                                      Dev Dependencies (9)

                                                      Peer Dependencies (0)

                                                      No peer dependencies.

                                                      Badge

                                                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/figlet.

                                                      • Markdown
                                                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/figlet)
                                                      • HTML
                                                        <a href="https://www.jsdocs.io/package/figlet"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>