Class PromptBuilder

Hierarchy

Base
- PromptBuilder

Index

Constructors

Properties

_input_default? _input_transform _input_validation _message rl

Methods

close prompt readLine setDefault setMessage setTransform setValidation validateUserInput

Constructors

constructor

new PromptBuilder(): PromptBuilder
Returns PromptBuilder
Inherited from Base.constructor
- Defined in Base.ts:10

Properties

`Private` `Optional` _input_default

_input_default?: string

`Private` _input_transform

_input_transform: ((input) => string) = ...

Type declaration

- (input): string
- Parameters
  - input: string
  Returns string

`Private` _input_validation

_input_validation: ((input) => boolean) = ...

Type declaration

- (input): boolean
- Parameters
  - input: string
  Returns boolean

`Private` _message

_message: string = ""

`Protected` rl

rl: Interface = ...

Methods

close

close(): void
Returns void
Inherited from Base.close
- Defined in Base.ts:22

prompt

prompt(): Promise<string>
Returns Promise<string>
- Defined in Builder/PromptBuilder.ts:53

`Protected` readLine

readLine(message?): Promise<string>
Parameters
- message: string = ""
Returns Promise<string>
Inherited from Base.readLine
- Defined in Base.ts:14

setDefault

setDefault(default_value): PromptBuilder
Sets the default value. If none is provided, the user will be prompted until they provide a valid input

Returns
The current instance of the builder
Parameters
- default_value: string
  
  The default value to use
Returns PromptBuilder
- Defined in Builder/PromptBuilder.ts:48

setMessage

setMessage(message): PromptBuilder
Sets the message that will be displayed to the user

Returns
The current instance of the builder
Parameters
- message: string
  
  The message to display to the user
Returns PromptBuilder
- Defined in Builder/PromptBuilder.ts:18

setTransform

setTransform(transform): PromptBuilder
Sets the transform function

Returns
The current instance of the builder
Parameters
- transform: ((input) => string)
  
  The transform function to use
  - - (input): string
    - Parameters
      
      input: string
      
      Returns string
Returns PromptBuilder
- Defined in Builder/PromptBuilder.ts:38

setValidation

setValidation(validation): PromptBuilder
Sets the validation function that will be used to validate the user's input

Returns
The current instance of the builder
Parameters
- validation: ((input) => boolean)
  
  The validation function to use
  - - (input): boolean
    - Parameters
      
      input: string
      
      Returns boolean
Returns PromptBuilder
- Defined in Builder/PromptBuilder.ts:28

validateUserInput

validateUserInput(input): boolean
Parameters
- input: string
Returns boolean
- Defined in Builder/PromptBuilder.ts:88

Generated using TypeDoc