Class Format

Formats various inputs into single string.

Index

Constructors

Methods

bold color command dim error highlight indent link list normalizeAmpxCommand note record sectionHeader success

Constructors

constructor

new Format(packageManagerRunnerName?: string): Format
Initialize with a package manager runner name. Defaults to attempting to load a value derived from environment variables.
Parameters
- packageManagerRunnerName: string = ...
Returns Format
- Defined in format/format.ts:25

Methods

bold

bold(message: string): string
Parameters
- message: string
Returns string
- Defined in format/format.ts:80

color

color(
message: string,
colorName: "Green" | "Yellow" | "Blue" | "Magenta" | "Cyan" | "Red",
): string
Parameters
- message: string
- colorName: "Green" | "Yellow" | "Blue" | "Magenta" | "Cyan" | "Red"
Returns string
- Defined in format/format.ts:102

command

command(command: string): string
Parameters
- command: string
Returns string
- Defined in format/format.ts:72

dim

dim(message: string): string
Parameters
- message: string
Returns string
- Defined in format/format.ts:82

error

error(error: unknown): string
Parameters
- error: unknown
Returns string
- Defined in format/format.ts:38

highlight

highlight(command: string): string
Parameters
- command: string
Returns string
- Defined in format/format.ts:74

indent

indent(message: string): string
Parameters
- message: string
Returns string
- Defined in format/format.ts:89

link

link(link: string): string
Parameters
- link: string
Returns string
- Defined in format/format.ts:84

list

list(lines: string[]): string
Parameters
- lines: string[]
Returns string
- Defined in format/format.ts:86

normalizeAmpxCommand

normalizeAmpxCommand(command: string): string
Parameters
- command: string
Returns string
- Defined in format/format.ts:29

note

note(message: string): string
Parameters
- message: string
Returns string
- Defined in format/format.ts:70

record

record(record: Record<string, string | number | Date>): string
Parameters
- record: Record<string, string | number | Date>
Returns string
- Defined in format/format.ts:97

sectionHeader

sectionHeader(header: string): string
Parameters
- header: string
Returns string
- Defined in format/format.ts:78

success

success(message: string): string
Parameters
- message: string
Returns string
- Defined in format/format.ts:76