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: unknown): ClientError
Log an error message to stderr.
Parameters
- error: unknown
  The error to log.
Returns ClientError
The error wrapped in a ClientError.
- Defined in core/client.ts:92

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:83

prompt

prompt<T extends PromptType = PromptType>(
prompt: PromptParams<T>,
): Promise<PromptPrimitiveType<T>>
Prompt the user for input.
Type Parameters
- T extends PromptType = PromptType
Parameters
- prompt: PromptParams<T>
  The prompt options.
Returns Promise<PromptPrimitiveType<T>>
The user's input.

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

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:108