Interfacegatewayv0.9.0

DefaultConfirmOptions

Options for the string-prompt form, adding the built-in Confirm/Cancel buttons' labels and style.

interface DefaultConfirmOptions extends ConfirmOptions

Properties

Cancel-button label.

cancelLabel?: string

Default:'Cancel'

Confirm-button label.

confirmLabel?: string

Default:'Confirm'

Confirm-button style.

confirmStyle?: ButtonStyle

Default:Danger

Whether the prompt is ephemeral. Only the invoking user can act on it either way, a non-invoker's click is ignored.

ephemeral?: boolean

Inherited from:ConfirmOptions

Default:true

Shown in place of the prompt when the user cancels. Absent removes the prompt.

onCancel?: Outcome

Inherited from:ConfirmOptions

Shown in place of the prompt when the user confirms. Absent removes the prompt.

onConfirm?: Outcome

Inherited from:ConfirmOptions

Shown in place of the prompt when the prompt times out. Absent removes the prompt.

onTimeout?: Outcome

Inherited from:ConfirmOptions

Milliseconds to wait for a click before the prompt is settled and the result resolves to false.

timeoutMs?: number

Inherited from:ConfirmOptions

Default:30_000