InteractiveContext

Defined in: packages/prompt/src/core/interactive.ts:12

Extends

• PromptContext<T>

Type Parameters

T

T

O

O extends CoreOpts<T>

S

S

Properties

abort

abort: () => void

Defined in: packages/prompt/src/core/static.ts:13

Returns

void

Inherited from

PromptContext.abort

---

done

done: (value) => void

Defined in: packages/prompt/src/core/static.ts:11

Parameters

value

T

Returns

void

Inherited from

PromptContext.done

---

error

error: (err) => void

Defined in: packages/prompt/src/core/static.ts:12

Parameters

err

unknown

Returns

void

Inherited from

PromptContext.error

---

input

input: ReadStream

Defined in: packages/prompt/src/core/static.ts:16

Inherited from

PromptContext.input

---

onKeypress

onKeypress: (handler) => void

Defined in: packages/prompt/src/core/interactive.ts:21

Parameters

handler

(key) => void

Returns

void

---

opts

opts: O

Defined in: packages/prompt/src/core/interactive.ts:17

Overrides

PromptContext.opts

---

output

output: WriteStream

Defined in: packages/prompt/src/core/static.ts:17

Inherited from

PromptContext.output

---

render

render: () => void

Defined in: packages/prompt/src/core/interactive.ts:20

Returns

void

---

setState

setState: (updater) => void

Defined in: packages/prompt/src/core/interactive.ts:19

Parameters

updater

(prev) => S

Returns

void

---

state

state: S

Defined in: packages/prompt/src/core/interactive.ts:18

---

theme

theme: Theme

Defined in: packages/prompt/src/core/static.ts:15

Inherited from

PromptContext.theme

---

validate

validate: (value) => Promise<T>

Defined in: packages/prompt/src/core/static.ts:14

Parameters

value

T

Returns

Promise<T>

Inherited from

PromptContext.validate

---

value

value: T | undefined

Defined in: packages/prompt/src/core/static.ts:10

Inherited from

PromptContext.value