Variable promptConst

prompt: {
    autocomplete: ((name, message, callback?) => AutocompletePrompt<string>);
    autocompleteMultiSelect: ((name, message, callback?) => AutoCompleteMultiSelectPrompt<number>);
    confirm: ((name, message, callback?) => ConfirmPrompt<boolean>);
    date: ((name, message, callback?) => DatePrompt<Date>);
    invisible: ((name, message, callback?) => InvisiblePrompt<string>);
    list: ((name, message, callback?) => ListPrompt<string>);
    multiselect: ((name, message, callback?) => MultiSelectPrompt<number>);
    number: ((name, message, callback?) => NumberPrompt<number>);
    password: ((name, message, callback?) => PasswordPrompt<string>);
    search: ((name, callback?) => SearchPrompt<string>);
    select: ((name, message, callback?) => SelectPrompt<number>);
    text: ((name, message, callback?) => TextPrompt<string>);
    toggle: ((name, message, callback?) => TogglePrompt<boolean>);
} = ...

User prompt module

Type declaration

  • autocomplete: ((name, message, callback?) => AutocompletePrompt<string>)
      • (name, message, callback?): AutocompletePrompt<string>

      • Parameters

        • name: string
        • message: string
        • Optional callback: ((self) => void)
            • (self): void

            • Parameters

              • self: AutocompletePrompt<string>

              Returns void

        Returns AutocompletePrompt<string>

  • autocompleteMultiSelect: ((name, message, callback?) => AutoCompleteMultiSelectPrompt<number>)
      • (name, message, callback?): AutoCompleteMultiSelectPrompt<number>

      • Parameters

        • name: string
        • message: string
        • Optional callback: ((self) => void)
            • (self): void

            • Parameters

              • self: AutoCompleteMultiSelectPrompt<number>

              Returns void

        Returns AutoCompleteMultiSelectPrompt<number>

  • confirm: ((name, message, callback?) => ConfirmPrompt<boolean>)
      • (name, message, callback?): ConfirmPrompt<boolean>

      • Parameters

        • name: string
        • message: string
        • Optional callback: ((self) => void)
            • (self): void

            • Parameters

              • self: ConfirmPrompt<boolean>

              Returns void

        Returns ConfirmPrompt<boolean>

  • date: ((name, message, callback?) => DatePrompt<Date>)
      • (name, message, callback?): DatePrompt<Date>

      • Parameters

        • name: string
        • message: string
        • Optional callback: ((self) => void)
            • (self): void

            • Parameters

              • self: DatePrompt<Date>

              Returns void

        Returns DatePrompt<Date>

  • invisible: ((name, message, callback?) => InvisiblePrompt<string>)
      • (name, message, callback?): InvisiblePrompt<string>

      • Parameters

        • name: string
        • message: string
        • Optional callback: ((self) => void)
            • (self): void

            • Parameters

              • self: InvisiblePrompt<string>

              Returns void

        Returns InvisiblePrompt<string>

  • list: ((name, message, callback?) => ListPrompt<string>)
      • (name, message, callback?): ListPrompt<string>

      • Parameters

        • name: string
        • message: string
        • Optional callback: ((self) => void)
            • (self): void

            • Parameters

              • self: ListPrompt<string>

              Returns void

        Returns ListPrompt<string>

  • multiselect: ((name, message, callback?) => MultiSelectPrompt<number>)
      • (name, message, callback?): MultiSelectPrompt<number>

      • Parameters

        • name: string
        • message: string
        • Optional callback: ((self) => void)
            • (self): void

            • Parameters

              • self: MultiSelectPrompt<number>

              Returns void

        Returns MultiSelectPrompt<number>

  • number: ((name, message, callback?) => NumberPrompt<number>)
      • (name, message, callback?): NumberPrompt<number>

      • Parameters

        • name: string
        • message: string
        • Optional callback: ((self) => void)
            • (self): void

            • Parameters

              • self: NumberPrompt<number>

              Returns void

        Returns NumberPrompt<number>

  • password: ((name, message, callback?) => PasswordPrompt<string>)
      • (name, message, callback?): PasswordPrompt<string>

      • Parameters

        • name: string
        • message: string
        • Optional callback: ((self) => void)
            • (self): void

            • Parameters

              • self: PasswordPrompt<string>

              Returns void

        Returns PasswordPrompt<string>

  • search: ((name, callback?) => SearchPrompt<string>)
      • (name, callback?): SearchPrompt<string>

      • Parameters

        • name: string
        • Optional callback: ((self) => void)
            • (self): void

            • Parameters

              • self: SearchPrompt<string>

              Returns void

        Returns SearchPrompt<string>

  • select: ((name, message, callback?) => SelectPrompt<number>)
      • (name, message, callback?): SelectPrompt<number>

      • Parameters

        • name: string
        • message: string
        • Optional callback: ((self) => void)
            • (self): void

            • Parameters

              • self: SelectPrompt<number>

              Returns void

        Returns SelectPrompt<number>

  • text: ((name, message, callback?) => TextPrompt<string>)
      • (name, message, callback?): TextPrompt<string>

      • Parameters

        • name: string
        • message: string
        • Optional callback: ((self) => void)
            • (self): void

            • Parameters

              • self: TextPrompt<string>

              Returns void

        Returns TextPrompt<string>

  • toggle: ((name, message, callback?) => TogglePrompt<boolean>)
      • (name, message, callback?): TogglePrompt<boolean>

      • Parameters

        • name: string
        • message: string
        • Optional callback: ((self) => void)
            • (self): void

            • Parameters

              • self: TogglePrompt<boolean>

              Returns void

        Returns TogglePrompt<boolean>

Example

await prompt
  .text('user', 'What is your  username?') //
  .run()

await prompt
  .password('pass', 'Enter password') //
  .run()

await prompt
  .number('age', 'How old are you?')
  .validate((value) => (value < 18 ? `Nightclub is 18+ only` : true))
  .run()

await prompt
  .confirm('confirm', 'Can you confirm this is your age?') //
  .initial(true)
  .run()

await prompt
  .list('kws', 'Enter some keywords')
  .separator(' ')
  .validate((arr) => (arr.length > 1 ? true : 'Please enter more than one'))
  .run()

await prompt
  .toggle('cool', 'Toggle Cool Mode') //
  .initial(true)
  .active('on')
  .inactive('off')
  .run()

await prompt
  .select('col1', 'Pick a color')
  .choices([
    { title: 'Red', description: 'This option has a description', value: '#ff0000' },
    { title: 'Green', value: '#00ff00', disabled: true },
    { title: 'Blue', value: '#0000ff' },
  ])
  .initial(0)
  .hint('Select your favorite.')
  .warn('Really not a good idea,')
  .run()

await prompt
  .multiselect('col2', 'Pick between 1 and 3 colors')
  .choices([
    { title: 'Black', value: '#000000', disabled: false, selected: false },
    { title: 'Red', value: '#ff0000', disabled: false, selected: false },
    { title: 'Green', value: '#00ff00', disabled: true, selected: false },
    { title: 'Blue', value: '#0000ff', disabled: false, selected: false },
    { title: 'White', value: '#ffffff', disabled: false, selected: true },
  ])
  .instructions('Here are some instructions')
  .min(1)
  .max(3)
  .hint('Select your favorite.')
  .warn('Really not a good idea,')
  .run()

await prompt
  .autocompleteMultiSelect('col3', 'Pick between 1 and 3 colors')
  .choices([
    { title: 'Black', value: '#000000', disabled: false, selected: false },
    { title: 'Red', value: '#ff0000', disabled: false, selected: false },
    { title: 'Green', value: '#00ff00', disabled: true, selected: false },
    { title: 'Blue', value: '#0000ff', disabled: false, selected: false },
    { title: 'White', value: '#ffffff', disabled: false, selected: true },
  ])
  .instructions('Here are some instructions')
  .min(1)
  .max(3)
  .hint('Select your favorite.')
  .warn('Really not a good idea,')
  .run()

await prompt
  .date('future', 'Select a date in the future')
  .initial(new Date())
  .validate((date) => (date > new Date() ? true : 'Date must be in the future'))
  .run()

await prompt
  .invisible('invisible', 'This is invisible') //
  .initial('secret')
  .run()

await prompt
  .autocomplete('actor', 'Pick your favorite actor')
  .choices([
    { title: 'Cage' },
    { title: 'Clooney', value: 'silver-fox' },
    { title: 'Gyllenhaal' },
    { title: 'Gibson' },
    { title: 'Grant' },
  ])
  .run()

await prompt
  .search('test')
  .choices(fs.readFileSync(__filename, 'utf8').split(/[\s\n\r]/))
  .filtering({ includes: true, startsWith: true })
  .clearFirst(true)
  .limit(30)
  .separator(' ')
  .run()

Settings

Member Visibility

Theme

Generated using TypeDoc