Class Client

A client that can be used to log messages, errors, and prompt the user.

This is a WIP and will be built out more in the future. For now, it's just a simple wrapper around console and prompts.

Index

Constructors

Methods

error log prompt warn

Constructors

constructor

new Client(): Client
Returns Client

Methods

error

error(error: any): ClientError
Log an error message to stderr.
Parameters
- error: any
  The error to log.
Returns ClientError
The error wrapped in a ClientError.
- Defined in core/client.ts:47

log

log(...message: unknown[]): void
Log a message to stdout.
Parameters
- ...message: unknown[]
  Any number of arguments to log.
Returns void
- Defined in core/client.ts:38

prompt

prompt<T extends PromptType = PromptType>(
    prompt: PromptOptions<T>,
): Promise<
    {
        autocomplete: string;
        autocompleteMultiselect: string[];
        confirm: boolean;
        date: Date;
        invisible: string;
        list: string[];
        multiselect: string[];
        number: number;
        password: string;
        select: string;
        text: string;
        toggle: boolean;
    }[T],
>
Prompt the user for input.
Type Parameters
- T extends PromptType = PromptType
Parameters
- prompt: PromptOptions<T>
  The prompt options.
Returns Promise<
    {
        autocomplete: string;
        autocompleteMultiselect: string[];
        confirm: boolean;
        date: Date;
        invisible: string;
        list: string[];
        multiselect: string[];
        number: number;
        password: string;
        select: string;
        text: string;
        toggle: boolean;
    }[T],
>
The user's input.

See
https://github.com/terkelg/prompts#-prompt-objects
- Defined in core/client.ts:74

warn

warn(...warning: any): void
Log a warning message to stdout.
Parameters
- ...warning: any
  Any number of arguments to log.
Returns void
- Defined in core/client.ts:63