API / @aionbuilders/nabu

ConfirmMessages

Type Stability: stable

Definition

TypeScript 
import type { ConfirmMessages } from '@aionbuilders/nabu';
TypeScript 
interface ConfirmMessages {
  cancelled?: string | ((p: { label: string }) => string);
  choose?: string | ((p: { keys: string; label: string; options: PendingOption[] }) => string);
  done?: string | ((p: { label: string }) => string);
  hold?: string | ((p: { keys: string; label: string }) => string);
  invite?: string | ((p: { keys: string; label: string }) => string);
  option?: string | ((p: { count: number; index: number; option: PendingOption }) => string);
}

Properties

Properties of ConfirmMessages
PropertyTypeDescription
cancelledoptionalstring | ((p: { label: string }) => string)

after a release / Escape / timeout

chooseoptionalstring | ((p: { keys: string; label: string; options: PendingOption[] }) => string)

prompt of a chooser

doneoptionalstring | ((p: { label: string }) => string)

after the command ran

holdoptionalstring | ((p: { keys: string; label: string }) => string)

prompt of a hold

inviteoptionalstring | ((p: { keys: string; label: string }) => string)

prompt of an invite

optionoptionalstring | ((p: { count: number; index: number; option: PendingOption }) => string)

the highlighted option

Source: src/lib/utils/command-confirm.svelte.js:97