Skip to content
Lantern0.3.1
API reference

banner

Import

Section titled “Import”
Import
import * as api from "@fungi.computer/lantern/banner";

Exports

Section titled “Exports”
Kind Export Description
type alias CliBrand
type alias BannerOptions
constant fungiWordmark Retained Botanical terminal art; spacing is part of the image.
constant vishnuWordmark Whimsy lettering, matching the retained Fungi mark’s ten-line canvas.
function colorizeBanner() A single truecolor wrap retains every space of the original art.
function renderBanner() Browser-safe renderer. Raw terminal writes need CRLF; ordinary TTYs own ONLCR.

CliBrandtype alias

Section titled “CliBrand”
Signature
type CliBrand = "fungi" | "vishnu" | "fungi-local-auth" | "computer";

BannerOptionstype alias

Section titled “BannerOptions”
Signature
type BannerOptions = object;

Properties

Section titled “Properties”

brand

Section titled “brand”
Signature
brand: CliBrand;

columns

Section titled “columns”
Signature
columns: number;

interactive

Section titled “interactive”
Signature
interactive: boolean;

noColor

Section titled “noColor”
Signature
noColor: boolean;

rawPty?

Section titled “rawPty?”
Signature
optional rawPty?: boolean;

fungiWordmarkconstant

Section titled “fungiWordmark”
Signature
const fungiWordmark: "\n\n     ,d8888b                               d8,\n     88P'                                 `8P\n  d888888P\n    ?88'    ?88   d8P  88bd88b  d888b8b    88b\n    88P     d88   88   88P' ?8bd8P' ?88    88P\n   d88      ?8(  d88  d88   88P88b  ,88b  d88\n  d88'      `?88P'?8bd88'   88b`?88P'`88bd88'\n                                    )88\n                                   ,88P\n                               `?8888P\n";

Retained Botanical terminal art; spacing is part of the image.

vishnuWordmarkconstant

Section titled “vishnuWordmark”
Signature
const vishnuWordmark: "\n\n             d8,         d8b\n            `8P          ?88\n                          88b\n  ?88   d8P  88b .d888b,  888888b   88bd88b ?88   d8P\n  d88  d8P'  88P ?8b,     88P `?8b  88P' ?8bd88   88\n  ?8b ,88'  d88    `?8b  d88   88P d88   88P?8(  d88\n  `?888P'  d88' `?888P' d88'   88bd88'   88b`?88P'?8b\n\n\n\n";

Whimsy lettering, matching the retained Fungi mark’s ten-line canvas.

colorizeBanner()function

Section titled “colorizeBanner()”
Signature
function colorizeBanner(art, brand?): string;

A single truecolor wrap retains every space of the original art.

Parameters

Section titled “Parameters”
Parameter Type Default value
art string undefined
brand CliBrand "fungi"

Returns

Section titled “Returns”

string

renderBanner()function

Section titled “renderBanner()”
Signature
function renderBanner(options): string;

Browser-safe renderer. Raw terminal writes need CRLF; ordinary TTYs own ONLCR.

Parameters

Section titled “Parameters”
Parameter Type
options BannerOptions

Returns

Section titled “Returns”

string