Skip to content
Lantern0.3.1
API reference

lantern

Import

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

Exports

Section titled “Exports”
Kind Export Description
class Cli Own terminal presentation; callers retain commands, credentials and state.
type alias CliOptions
type alias SearchChoice Already ordered choices; the caller owns group membership and labels.
type alias SearchOptions

Cliclass

Section titled “Cli”

Own terminal presentation; callers retain commands, credentials and state.

Constructors

Section titled “Constructors”

Constructor

Section titled “Constructor”
Signature
new Cli(options): Cli;
Parameters
Section titled “Parameters”
Parameter Type
options CliOptions
Returns
Section titled “Returns”

Cli

Properties

Section titled “Properties”

interactive

Section titled “interactive”
Signature
readonly interactive: boolean;

Methods

Section titled “Methods”

welcome()

Section titled “welcome()”
Signature
welcome(message): void;
Parameters
Section titled “Parameters”
Parameter Type
message string
Returns
Section titled “Returns”

void

select()

Section titled “select()”
Signature
select<Value>(options): Promise<symbol | Value>;
Type Parameters
Section titled “Type Parameters”
Type Parameter
Value
Parameters
Section titled “Parameters”
Parameter Type
options SelectOptions<Value>
Returns
Section titled “Returns”

Promise<symbol | Value>

text()

Section titled “text()”
Signature
text(options): Promise<string | symbol>;
Parameters
Section titled “Parameters”
Parameter Type
options TextOptions
Returns
Section titled “Returns”

Promise<string | symbol>

Section titled “search()”
Signature
search(options): Promise<string | symbol>;
Parameters
Section titled “Parameters”
Parameter Type
options SearchOptions
Returns
Section titled “Returns”

Promise<string | symbol>

password()

Section titled “password()”
Signature
password(options): Promise<string | symbol>;
Parameters
Section titled “Parameters”
Parameter Type
options PasswordOptions
Returns
Section titled “Returns”

Promise<string | symbol>

confirm()

Section titled “confirm()”
Signature
confirm(options): Promise<boolean | symbol>;
Parameters
Section titled “Parameters”
Parameter Type
options ConfirmOptions
Returns
Section titled “Returns”

Promise<boolean | symbol>

info()

Section titled “info()”
Signature
info(message): void;
Parameters
Section titled “Parameters”
Parameter Type
message string
Returns
Section titled “Returns”

void

url()

Section titled “url()”
Signature
url(url): void;

Show a URL inside the prompt frame as one unbroken line. info() and step() add a status symbol; this keeps only the frame’s “│” bar before the URL and never inserts a line break, so the terminal soft-wraps it and a selection from its first character copies the whole URL.

Parameters
Section titled “Parameters”
Parameter Type
url string
Returns
Section titled “Returns”

void

Section titled “link()”
Signature
link(label, url): string;

An OSC 8 hyperlink around a short label, for terminals that render it. Falls back to the plain label when output is non-interactive, piped, or NO_COLOR/dumb — the same signal info() already uses to decide whether to use clack’s styling at all.

Parameters
Section titled “Parameters”
Parameter Type
label string
url string
Returns
Section titled “Returns”

string

step()

Section titled “step()”
Signature
step(message): void;
Parameters
Section titled “Parameters”
Parameter Type
message string
Returns
Section titled “Returns”

void

outro()

Section titled “outro()”
Signature
outro(message): void;
Parameters
Section titled “Parameters”
Parameter Type
message string
Returns
Section titled “Returns”

void

cancel()

Section titled “cancel()”
Signature
cancel(message): void;
Parameters
Section titled “Parameters”
Parameter Type
message string
Returns
Section titled “Returns”

void

task()

Section titled “task()”
Signature
task<T>(message, work): Promise<T>;

Stop animation on both success and failure, without exposing error payloads.

Type Parameters
Section titled “Type Parameters”
Type Parameter
T
Parameters
Section titled “Parameters”
Parameter Type
message string
work (update) => Promise<T>
Returns
Section titled “Returns”

Promise<T>

checklist()

Section titled “checklist()”
Signature
checklist(): (label, ok, detail) => void;

Shared doctor checklist; the caller owns what constitutes a pass.

Returns
Section titled “Returns”

(label, ok, detail) => void

CliOptionstype alias

Section titled “CliOptions”
Signature
type CliOptions = object;

Properties

Section titled “Properties”

brand

Section titled “brand”
Signature
brand: CliBrand;

input?

Section titled “input?”
Signature
optional input?: Readable;

output?

Section titled “output?”
Signature
optional output?: Writable;

interactive?

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

columns?

Section titled “columns?”
Signature
optional columns?: number;

SearchChoicetype alias

Section titled “SearchChoice”
Signature
type SearchChoice = Readonly<{
  value: string;
  label: string;
  description?: string;
  group?: string;
}>;

Already ordered choices; the caller owns group membership and labels.

SearchOptionstype alias

Section titled “SearchOptions”
Signature
type SearchOptions = Readonly<{
  message: string;
  choices: readonly SearchChoice[];
  collapsedGroup?: string;
  signal?: AbortSignal;
}>;

References

Section titled “References”

renderBanner

Section titled “renderBanner”

Re-exports renderBanner