print.ts

Declarations
#

12 declarations

configure_print_colors
#

(s: ((format: ForegroundColors | BackgroundColors | Modifiers | (ForegroundColors | BackgroundColors | Modifiers)[], text: string, options?: StyleTextOptions | undefined) => string) | null | undefined): (format: ForegroundColors | ... 2 more ... | (ForegroundColors | ... 1 more ... | Modifiers)[], text: string, options?: StyleTextOptions | undefined) => string

import {configure_print_colors} from '@fuzdev/fuz_util/print.js';

Configures the module-level styling function for colored output.

`s`

type

((format: ForegroundColors | BackgroundColors | Modifiers | (ForegroundColors | BackgroundColors | Modifiers)[], text: string, options?: StyleTextOptions | undefined) => string) | null | undefined

returns

(format: ForegroundColors | BackgroundColors | Modifiers | (ForegroundColors | BackgroundColors | Modifiers)[], text: string, options?: StyleTextOptions | undefined) => string

print_boolean
#

print.ts view source

(value: boolean): string import {print_boolean} from '@fuzdev/fuz_util/print.js';

Formats a boolean for printing.

`value`

type boolean

returns

string

print_error
#

print.ts view source

(err: Error): string import {print_error} from '@fuzdev/fuz_util/print.js';

Formats an error for printing. Because throwing errors and rejecting promises isn't typesafe, don't assume the arg is an Error and try to return something useful.

`err`

type Error

returns

string

print_key_value
#

print.ts view source

(key: string, value: string | number): string import {print_key_value} from '@fuzdev/fuz_util/print.js';

Formats a key-value pair for printing.

`key`

type string

`value`

type string | number

returns

string

print_ms
#

print.ts view source

(ms: number, decimals?: number | undefined, separator?: string | undefined): string import {print_ms} from '@fuzdev/fuz_util/print.js';

Formats a number of milliseconds for printing.

`ms`

type number

`decimals?`

type number | undefined

optional

`separator?`

type string | undefined

optional

returns

string

print_number
#

print.ts view source

(value: number): string import {print_number} from '@fuzdev/fuz_util/print.js';

Formats a number for printing.

`value`

type number

returns

string

print_number_with_separators
#

print.ts view source

(v: string, separator?: string): string import {print_number_with_separators} from '@fuzdev/fuz_util/print.js';

Formats a number with separators for improved readability.

`v`

type string

`separator`

type string

default ','

returns

string

print_string
#

print.ts view source

(value: string): string import {print_string} from '@fuzdev/fuz_util/print.js';

Formats a string for printing.

`value`

type string

returns

string

print_timing
#

print.ts view source

(key: string | number, timing: number | undefined): string import {print_timing} from '@fuzdev/fuz_util/print.js';

Formats a timing entry with key for printing.

`key`

type string | number

`timing`

type number | undefined

returns

string

print_timings
#

print.ts view source

(timings: Timings, log: Logger): void import {print_timings} from '@fuzdev/fuz_util/print.js';

Prints all timings in a Timings object.

`timings`

type Timings

`log`

type Logger

returns

void

print_value
#

print.ts view source

(value: unknown): string import {print_value} from '@fuzdev/fuz_util/print.js';

Formats any value for printing.

`value`

type unknown

returns

string

st
#

print.ts view source

(format: ForegroundColors | BackgroundColors | Modifiers | (ForegroundColors | BackgroundColors | Modifiers)[], text: string, options?: StyleTextOptions | undefined): string

import {st} from '@fuzdev/fuz_util/print.js';

`format`

`text`

type string

`options?`

type StyleTextOptions | undefined

optional

returns

string