Class Client

A client that wraps the Node.js console and provides additional methods for logging, error handling, and user prompts.

See

GitHub - terkelg/prompts.

Hierarchy

Console
- Client

Index

Constructors

Methods

confirm error prompt

Constructors

constructor

new Client(
    __namedParameters?: {
        stderr?: WriteStream & {};
        stdout?: WriteStream & {};
    },
): Client
Parameters
- __namedParameters: { stderr?: WriteStream & {}; stdout?: WriteStream & {} } = {}
Returns Client
Overrides Console.constructor
- Defined in packages/cli/src/core/client.ts:95

Methods

confirm

confirm(message: string, initial?: boolean): Promise<boolean>
Prompt the user for confirmation.
Parameters
- message: string
  The confirmation message.
- initial: boolean = true
Returns Promise<boolean>
Whether the user confirmed.

Params
initial - The initial value for the confirmation prompt. Defaults to true.
- Defined in packages/cli/src/core/client.ts:144

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.
Overrides Console.error
- Defined in packages/cli/src/core/client.ts:104

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 packages/cli/src/core/client.ts:123