Class DefaultAsciiBannerGeneratorService

Service allowing a text string to be rendered using an ASCII banner font.

Hierarchy (View Summary)

DefaultAsciiBannerGeneratorService
- ChiselFontAsciiBannerGeneratorService

Implements

AsciiBannerGeneratorService

Index

Constructors

Methods

applyBackgroundEffect applyForegroundEffect generate getRegisteredFonts registerFont

Constructors

constructor

new DefaultAsciiBannerGeneratorService(): DefaultAsciiBannerGeneratorService
Returns DefaultAsciiBannerGeneratorService
- Defined in src/service/asciiBannerGenerator/DefaultAsciiBannerGeneratorService.ts:89

Methods

`Protected`applyBackgroundEffect

applyBackgroundEffect(lines: string[], effect: ColorEffect): string[]
Parameters
- lines: string[]
- effect: ColorEffect
Returns string[]
- Defined in src/service/asciiBannerGenerator/DefaultAsciiBannerGeneratorService.ts:166

`Protected`applyForegroundEffect

applyForegroundEffect(lines: string[], effect: ColorEffect): string[]
Parameters
- lines: string[]
- effect: ColorEffect
Returns string[]
- Defined in src/service/asciiBannerGenerator/DefaultAsciiBannerGeneratorService.ts:106

generate

generate(message: string, options?: BannerGenerateOptions): Promise<string>
Generate an ASCII banner text for the message using the specified options.
Parameters
- message: string
  the message to output.
- Optionaloptions: BannerGenerateOptions
  optional generation options.
Returns Promise<string>
Implementation of AsciiBannerGeneratorService.generate
- Defined in src/service/asciiBannerGenerator/DefaultAsciiBannerGeneratorService.ts:207

getRegisteredFonts

getRegisteredFonts(): readonly string[]
Return the names of the currently registered fonts.

Returns readonly string[]
Implementation of AsciiBannerGeneratorService.getRegisteredFonts
- Defined in src/service/asciiBannerGenerator/DefaultAsciiBannerGeneratorService.ts:93

registerFont

registerFont(fontName: string, fontDefinition: string): void
Register a new font.

The recommended way to load the font definition is to convert the font definition to a JSON string (replacing newlines with \n) and placing in a simple JSON file: { "font": "<figlet font definition>" }. This can then be imported as follows:

import { font as myFont } from "./myfont.json" with { type: "json" };
Parameters
- fontName: string
  the name used to refer to the font.
- fontDefinition: string
  the definition for the syntax conforming to the FIGfont format.
Returns void
Implementation of AsciiBannerGeneratorService.registerFont
- Defined in src/service/asciiBannerGenerator/DefaultAsciiBannerGeneratorService.ts:97