@microsoft/agents-hosting-dialogs 0.2.14 → 0.3.5

package/src/memory/pathResolvers/dollarPathResolver.ts

@@ -4,10 +4,15 @@
  */
 import { AliasPathResolver } from './aliasPathResolver'
 
+/**
+ * A path resolver that resolves paths starting with a dollar sign ('$')
+ * to the 'dialog.' namespace.
+ */
 export class DollarPathResolver extends AliasPathResolver {
   /**
-     * Initializes a new instance of the DollarPathResolver class.
-     */
+   * Initializes a new instance of the DollarPathResolver class.
+   * This resolver maps paths starting with '$' to the 'dialog.' namespace.
+   */
   constructor () {
     super('$', 'dialog.')
   }

package/src/memory/pathResolvers/hashPathResolver.ts

@@ -4,10 +4,15 @@
  */
 import { AliasPathResolver } from './aliasPathResolver'
 
+/**
+ * A path resolver that resolves paths starting with a hash sign ('#')
+ * to the 'turn.recognized.intents.' namespace.
+ */
 export class HashPathResolver extends AliasPathResolver {
   /**
-     * Initializes a new instance of the HashPathResolver class.
-     */
+   * Initializes a new instance of the HashPathResolver class.
+   * This resolver maps paths starting with '#' to the 'turn.recognized.intents.' namespace.
+   */
   constructor () {
     super('#', 'turn.recognized.intents.')
   }

package/src/memory/pathResolvers/pathResolver.ts

@@ -3,12 +3,17 @@
  * Licensed under the MIT License.
  */
 
+/**
+ * Interface for resolving and transforming paths.
+ * Implementations of this interface define how specific path patterns
+ * should be transformed into other formats or namespaces.
+ */
 export interface PathResolver {
   /**
-     * Transform the path
-     *
-     * @param path Path to inspect.
-     * @returns Transformed path
-     */
+   * Transforms the given path into a new format or namespace.
+   *
+   * @param path - The path to inspect and transform.
+   * @returns The transformed path.
+   */
   transformPath(path: string): string;
 }

package/src/memory/pathResolvers/percentPathResolver.ts

@@ -4,10 +4,15 @@
  */
 import { AliasPathResolver } from './aliasPathResolver'
 
+/**
+ * A path resolver that resolves paths starting with a percent sign ('%')
+ * to the 'class.' namespace.
+ */
 export class PercentPathResolver extends AliasPathResolver {
   /**
-     * Initializes a new instance of the PercentPathResolver class.
-     */
+   * Initializes a new instance of the PercentPathResolver class.
+   * This resolver maps paths starting with '%' to the 'class.' namespace.
+   */
   constructor () {
     super('%', 'class.')
   }

package/src/memory/scopePath.ts

@@ -7,13 +7,48 @@
  * Defines paths for the available scopes.
  */
 export class ScopePath {
+  /**
+   * Path for user-specific data.
+   */
   static readonly user = 'user'
+
+  /**
+   * Path for conversation-specific data.
+   */
   static readonly conversation = 'conversation'
+
+  /**
+   * Path for dialog-specific data.
+   */
   static readonly dialog = 'dialog'
+
+  /**
+   * Path for dialog class-specific data.
+   */
   static readonly dialogClass = 'dialogClass'
+
+  /**
+   * Path for dialog context-specific data.
+   */
   static readonly dialogContext = 'dialogContext'
+
+  /**
+   * Path for the current dialog instance data.
+   */
   static readonly this = 'this'
+
+  /**
+   * Path for class-specific data.
+   */
   static readonly class = 'class'
+
+  /**
+   * Path for settings-specific data.
+   */
   static readonly settings = 'settings'
+
+  /**
+   * Path for turn-specific data.
+   */
   static readonly turn = 'turn'
 }

package/src/memory/scopes/classMemoryScope.ts

@@ -7,22 +7,26 @@ import { ScopePath } from '../scopePath'
 import { DialogContext } from '../../dialogContext'
 import { Dialog } from '../../dialog'
 
+/**
+ * A memory scope that provides access to the properties of the active dialog.
+ * This scope binds to the active dialog and clones its properties for use in memory.
+ */
 export class ClassMemoryScope extends MemoryScope {
   /**
-     * Initializes a new instance of the ClassMemoryScope class.
-     *
-     * @param name Name of the scope class.
-     */
+   * Initializes a new instance of the ClassMemoryScope class.
+   *
+   * @param name - Name of the scope class. Defaults to `ScopePath.class`.
+   */
   constructor (name = ScopePath.class) {
     super(name, false)
   }
 
   /**
-     * Gets the backing memory for this scope.
-     *
-     * @param dialogContext The DialogContext object for this turn.
-     * @returns The memory for the scope.
-     */
+   * Gets the backing memory for this scope.
+   *
+   * @param dialogContext - The DialogContext object for this turn.
+   * @returns The memory for the scope, containing cloned properties of the active dialog.
+   */
   getMemory (dialogContext: DialogContext): object {
     // if active dialog is a container dialog then "dialog" binds to it
     if (dialogContext.activeDialog) {
@@ -52,11 +56,11 @@ export class ClassMemoryScope extends MemoryScope {
   }
 
   /**
-     * Override to find the dialog instance referenced by the scope.
-     *
-     * @param dialogContext Current dialog context.
-     * @returns The dialog instance referenced by the scope.
-     */
+   * Override to find the dialog instance referenced by the scope.
+   *
+   * @param dialogContext - Current dialog context.
+   * @returns The dialog instance referenced by the scope, or undefined if not found.
+   */
   protected onFindDialog (dialogContext: DialogContext): Dialog | undefined {
     return dialogContext.findDialog(dialogContext.activeDialog.id)
   }

package/src/memory/scopes/dialogClassMemoryScope.ts

@@ -8,19 +8,25 @@ import { DialogContext } from '../../dialogContext'
 import { Dialog } from '../../dialog'
 import { DialogContainer } from '../../dialogContainer'
 
+/**
+ * A memory scope that provides access to the properties of the active dialog class.
+ * This scope resolves to the active dialog if it is a container, or to its parent dialog.
+ */
 export class DialogClassMemoryScope extends ClassMemoryScope {
   /**
-     * Initializes a new instance of the DialogClassMemoryScope class.
-     */
+   * Initializes a new instance of the DialogClassMemoryScope class.
+   */
   constructor () {
     super(ScopePath.dialogClass)
   }
 
   /**
-     * @protected
-     * @param dialogContext The DialogContext object for this turn.
-     * @returns The current Dialog.
-     */
+   * @protected
+   * Finds the dialog instance referenced by the scope.
+   *
+   * @param dialogContext - The DialogContext object for this turn.
+   * @returns The current dialog, or its parent dialog if applicable.
+   */
   protected onFindDialog (dialogContext: DialogContext): Dialog | undefined {
     // Is the active dialog a container?
     const dialog = dialogContext.findDialog(dialogContext.activeDialog.id)

package/src/memory/scopes/dialogContextMemoryScope.ts

@@ -7,20 +7,24 @@ import { DialogContext } from '../../dialogContext'
 import { MemoryScope } from './memoryScope'
 import { ScopePath } from '../scopePath'
 
+/**
+ * A memory scope that provides access to the dialog context.
+ * This scope includes information about the active dialog, its parent, and the dialog stack.
+ */
 export class DialogContextMemoryScope extends MemoryScope {
   /**
-     * Initializes a new instance of the `DialogContextMemoryScope` class.
-     */
+   * Initializes a new instance of the `DialogContextMemoryScope` class.
+   */
   constructor () {
     super(ScopePath.dialogContext, false)
   }
 
   /**
-     * Gets the backing memory for this scope.
-     *
-     * @param dialogContext The `DialogContext` object for this turn.
-     * @returns Memory for the scope.
-     */
+   * Gets the backing memory for this scope.
+   *
+   * @param dialogContext - The `DialogContext` object for this turn.
+   * @returns An object containing the dialog stack, active dialog ID, and parent dialog ID.
+   */
   getMemory (dialogContext: DialogContext): Record<'stack' | 'activeDialog' | 'parent', unknown> {
     const stack = []
     let currentDialogContext: DialogContext | undefined = dialogContext

package/src/memory/scopes/dialogMemoryScope.ts

@@ -7,20 +7,24 @@ import { ScopePath } from '../scopePath'
 import { DialogContext } from '../../dialogContext'
 import { DialogContainer } from '../../dialogContainer'
 
+/**
+ * A memory scope that provides access to the active dialog's state.
+ * This scope binds to the active dialog if it is a container, or to its parent dialog if applicable.
+ */
 export class DialogMemoryScope extends MemoryScope {
   /**
-     * Initializes a new instance of the DialogMemoryScope class.
-     */
+   * Initializes a new instance of the DialogMemoryScope class.
+   */
   constructor () {
     super(ScopePath.dialog)
   }
 
   /**
-     * Gets the backing memory for this scope.
-     *
-     * @param dialogContext The DialogContext object for this turn.
-     * @returns The memory for the scope.
-     */
+   * Gets the backing memory for this scope.
+   *
+   * @param dialogContext - The DialogContext object for this turn.
+   * @returns The memory for the scope.
+   */
   getMemory (dialogContext: DialogContext): object {
     // If active dialog is a container dialog then "dialog" binds to it.
     // Otherwise the "dialog" will bind to the dialogs parent assuming it
@@ -35,11 +39,12 @@ export class DialogMemoryScope extends MemoryScope {
   }
 
   /**
-     * Changes the backing object for the memory scope.
-     *
-     * @param dialogContext The DialogContext object for this turn.
-     * @param memory Memory object to set for the scope.
-     */
+   * Changes the backing object for the memory scope.
+   *
+   * @param dialogContext - The DialogContext object for this turn.
+   * @param memory - Memory object to set for the scope.
+   * @throws Will throw an error if the memory object is undefined or if no active dialog is found.
+   */
   setMemory (dialogContext: DialogContext, memory: object): void {
     if (memory === undefined) {
       throw new Error('DialogMemoryScope.setMemory: undefined memory object passed in.')
@@ -62,10 +67,12 @@ export class DialogMemoryScope extends MemoryScope {
   }
 
   /**
-     * @private
-     * @param dialogContext The DialogContext object for this turn.
-     * @returns A boolean indicating whether is a cointainer or not.
-     */
+   * Determines if the given dialog context is a container.
+   *
+   * @private
+   * @param dialogContext - The DialogContext object for this turn.
+   * @returns A boolean indicating whether the dialog context is a container.
+   */
   private isContainer (dialogContext: DialogContext): boolean {
     if (dialogContext !== undefined && dialogContext.activeDialog !== undefined) {
       const dialog = dialogContext.findDialog(dialogContext.activeDialog.id)

package/src/memory/scopes/turnMemoryScope.ts

@@ -12,22 +12,23 @@ import { DialogContext } from '../../dialogContext'
 const TURN_STATE = 'turn'
 
 /**
- * TurnMemoryScope represents memory scoped to the current turn.
+ * A memory scope that provides access to the turn's state.
+ * This scope is used to store and retrieve information specific to the current turn.
  */
 export class TurnMemoryScope extends MemoryScope {
   /**
-     * Initializes a new instance of the TurnMemoryScope class.
-     */
+   * Initializes a new instance of the TurnMemoryScope class.
+   */
   constructor () {
     super(ScopePath.turn, true)
   }
 
   /**
-     * Get the backing memory for this scope.
-     *
-     * @param dialogContext The DialogContext for this turn.
-     * @returns The memory for the scope.
-     */
+   * Gets the backing memory for this scope.
+   *
+   * @param dialogContext - The DialogContext object for this turn.
+   * @returns The memory for the scope.
+   */
   getMemory (dialogContext: DialogContext): object {
     let memory = dialogContext.context.turnState.get(TURN_STATE)
     if (typeof memory !== 'object') {
@@ -39,11 +40,11 @@ export class TurnMemoryScope extends MemoryScope {
   }
 
   /**
-     * Changes the backing object for the memory scope.
-     *
-     * @param dialogContext The DialogContext for this turn.
-     * @param memory Memory object to set for the scope.
-     */
+   * Changes the backing object for the memory scope.
+   *
+   * @param dialogContext - The DialogContext object for this turn.
+   * @param memory - Memory object to set for the scope.
+   */
   setMemory (dialogContext: DialogContext, memory: object): void {
     if (memory === undefined) {
       throw new Error('TurnMemoryScope.setMemory: undefined memory object passed in.')

package/src/memory/turnPath.ts

@@ -4,42 +4,78 @@
  */
 
 /**
- * Defines path for avaiable turns.
+ * Defines path for available turns.
  */
 export class TurnPath {
-  /// The result from the last dialog that was called.
-  static readonly lastResult = 'turn.lastresult'
+  /**
+   * The result from the last dialog that was called.
+   * @constant A string key representing the last result path (`'turn.lastresult'`).
+   */
+  static readonly lastResult: string = 'turn.lastresult'
 
-  /// The current activity for the turn.
-  static readonly activity = 'turn.activity'
+  /**
+   * The current activity for the turn.
+   * @constant A string key representing the activity path (`'turn.activity'`).
+   */
+  static readonly activity: string = 'turn.activity'
 
-  /// The recognized result for the current turn.
-  static readonly recognized = 'turn.recognized'
+  /**
+   * The recognized result for the current turn.
+   * @constant A string key representing the recognized result path (`'turn.recognized'`).
+   */
+  static readonly recognized: string = 'turn.recognized'
 
-  /// Path to the top intent.
-  static readonly topIntent = 'turn.recognized.intent'
+  /**
+   * Path to the top intent.
+   * @constant A string key representing the top intent path (`'turn.recognized.intent'`).
+   */
+  static readonly topIntent: string = 'turn.recognized.intent'
 
-  /// Path to the top score.
-  static readonly topScore = 'turn.recognized.score'
+  /**
+   * Path to the top score.
+   * @constant A string key representing the top score path (`'turn.recognized.score'`).
+   */
+  static readonly topScore: string = 'turn.recognized.score'
 
-  /// Original text.
-  static readonly text = 'turn.recognized.text'
+  /**
+   * Original text.
+   * @constant A string key representing the original text path (`'turn.recognized.text'`).
+   */
+  static readonly text: string = 'turn.recognized.text'
 
-  /// Original utterance split into unrecognized strings.
-  static readonly unrecognizedText = 'turn.unrecognizedText'
+  /**
+   * Original utterance split into unrecognized strings.
+   * @constant A string key representing the unrecognized text path (`'turn.unrecognizedText'`).
+   */
+  static readonly unrecognizedText: string = 'turn.unrecognizedText'
 
-  /// Entities that were recognized from text.
-  static readonly recognizedEntities = 'turn.recognizedEntities'
+  /**
+   * Entities that were recognized from text.
+   * @constant A string key representing the recognized entities path (`'turn.recognizedEntities'`).
+   */
+  static readonly recognizedEntities: string = 'turn.recognizedEntities'
 
-  /// If true an interruption has occured.
-  static readonly interrupted = 'turn.interrupted'
+  /**
+   * If true, an interruption has occurred.
+   * @constant A string key representing the interrupted path (`'turn.interrupted'`).
+   */
+  static readonly interrupted: string = 'turn.interrupted'
 
-  /// The current dialog event (set during event processings).
-  static readonly dialogEvent = 'turn.dialogEvent'
+  /**
+   * The current dialog event (set during event processing).
+   * @constant A string key representing the dialog event path (`'turn.dialogEvent'`).
+   */
+  static readonly dialogEvent: string = 'turn.dialogEvent'
 
-  /// Used to track that we don't end up in infinite loop of RepeatDialogs().
-  static readonly repeatedIds = 'turn.repeatedIds'
+  /**
+   * Used to track that we don't end up in an infinite loop of RepeatDialogs().
+   * @constant A string key representing the repeated IDs path (`'turn.repeatedIds'`).
+   */
+  static readonly repeatedIds: string = 'turn.repeatedIds'
 
-  /// This is a bool which if set means that the turncontext.activity has been consumed by some component in the system.
-  static readonly activityProcessed = 'turn.activityProcessed'
+  /**
+   * Indicates whether the turncontext.activity has been consumed by some component in the system.
+   * @constant A string key representing the activity processed path (`'turn.activityProcessed'`).
+   */
+  static readonly activityProcessed: string = 'turn.activityProcessed'
 }

package/src/prompts/attachmentPrompt.ts

@@ -10,7 +10,7 @@ import { Attachment, InputHints } from '@microsoft/agents-activity'
  * Prompts a user to upload attachments like images.
  *
  * @remarks
- * By default the prompt will return to the calling dialog an `Attachment[]`.
+ * By default the prompt will return to the calling dialog an {@link Attachment[]}.
  */
 export class AttachmentPrompt extends Prompt<Attachment[]> {
   // eslint-disable-next-line @typescript-eslint/no-useless-constructor

package/src/prompts/choicePrompt.ts

@@ -9,7 +9,22 @@ import { PromptCultureModels } from './promptCultureModels'
 import { Activity } from '@microsoft/agents-activity'
 
 // Need ChoiceDefaultsProperty so we can set choiceDefaults dynamically with lambda
+
+/**
+ * Represents a dictionary of default choice options for different locales.
+ *
+ * @remarks
+ * This interface is used to define the default options for rendering choices in prompts,
+ * such as separators, inline options, and whether to include numbers.
+ */
 export interface ChoiceDefaultsChoicePrompt {
+  /**
+   * A mapping of locale strings to their corresponding choice factory options.
+   *
+   * @remarks
+   * Each locale key maps to a `ChoiceFactoryOptions` object that defines the
+   * default behavior for rendering choices in that locale.
+   */
   [locale: string]: ChoiceFactoryOptions;
 }
 
@@ -17,12 +32,12 @@ export interface ChoiceDefaultsChoicePrompt {
  * Prompts a user to select from a list of choices.
  *
  * @remarks
- * By default the prompt will return to the calling dialog a `FoundChoice` object containing the
+ * By default the prompt will return to the calling dialog a {@link FoundChoice} object containing the
  * choice that was selected.
  */
 export class ChoicePrompt extends Prompt<FoundChoice> {
   /**
-     * A dictionary of Default Choices based on [[PromptCultureModels.getSupportedCultures()]].
+     * A dictionary of Default Choices based on {@link PromptCultureModels.getSupportedCultures | PromptCultureModels.getSupportedCultures method}.
      * Can be replaced by user using the constructor that contains choiceDefaults.
      */
   private choiceDefaults: ChoiceDefaultsChoicePrompt
@@ -47,7 +62,7 @@ export class ChoicePrompt extends Prompt<FoundChoice> {
   choiceOptions: ChoiceFactoryOptions | undefined
 
   /**
-     * Additional options passed to the underlying `recognizeChoices()` function.
+     * Additional options passed to the underlying {@link recognizeChoices | recognizeChoices function }.
      */
   recognizerOptions: FindChoicesOptions | undefined
 

package/src/prompts/confirmPrompt.ts

@@ -23,7 +23,7 @@ export interface ChoiceDefaultsConfirmPrompt {
  */
 export class ConfirmPrompt extends Prompt<boolean> {
   /**
-     * A dictionary of Default Choices based on [[PromptCultureModels.getSupportedCultures()]].
+     * A dictionary of Default Choices based on {@link PromptCultureModels.getSupportedCultures | PromptCultureModels.getSupportedCultures} method.
      * Can be replaced by user using the constructor that contains choiceDefaults.
      * This is initially set in the constructor.
      */
@@ -37,12 +37,12 @@ export class ConfirmPrompt extends Prompt<boolean> {
      * Style of the "yes" and "no" choices rendered to the user when prompting.
      *
      * @remarks
-     * Defaults to `ListStyle.auto`.
+     * Defaults to {@link ListStyle.auto}.
      */
   style: ListStyle
 
   /**
-     * Additional options passed to the `ChoiceFactory` and used to tweak the style of choices
+     * Additional options passed to the {@link ChoiceFactory } and used to tweak the style of choices
      * rendered to the user.
      */
   choiceOptions: ChoiceFactoryOptions | undefined
@@ -55,10 +55,10 @@ export class ConfirmPrompt extends Prompt<boolean> {
   /**
      * Creates a new ConfirmPrompt instance.
      *
-     * @param dialogId Unique ID of the dialog within its parent `DialogSet` or `ComponentDialog`.
+     * @param dialogId Unique ID of the dialog within its parent {@link DialogSet} or {@link ComponentDialog}.
      * @param validator (Optional) validator that will be called each time the user responds to the prompt.
-     * @param defaultLocale (Optional) locale to use if `TurnContext.activity.locale` is not specified. Defaults to a value of `en-us`.
-     * @param choiceDefaults (Optional) Overrides the dictionary of Default Choices on [[PromptCultureModels.getSupportedCultures()]].
+     * @param defaultLocale (Optional) locale to use if {@link TurnContext.activity.locale} is not specified. Defaults to a value of `en-us`.
+     * @param choiceDefaults (Optional) Overrides the dictionary of Default Choices on {@link PromptCultureModels.getSupportedCultures | PromptCultureModels.getSupportedCultures} method.
      */
   constructor (
     dialogId: string,

package/src/prompts/datetimePrompt.ts

@@ -8,7 +8,7 @@ import { Prompt, PromptOptions, PromptRecognizerResult, PromptValidator } from '
 import { Activity, InputHints } from '@microsoft/agents-activity'
 
 /**
- * Result returned by the `DateTimePrompt`.
+ * Result returned by the {@link DateTimePrompt}.
  */
 export interface DateTimeResolution {
   /**
@@ -23,8 +23,8 @@ export interface DateTimeResolution {
   type: string;
 
   /**
-     * Value of the specified [type](#type) that's a reasonable approximation given the ambiguity
-     * of the [timex](#timex).
+     * Value of the specified `type` that's a reasonable approximation given the ambiguity
+     * of the `timex`.
      */
   value: string;
 }
@@ -33,7 +33,7 @@ export interface DateTimeResolution {
  * Prompts a user to enter a datetime expression.
  *
  * @remarks
- * By default the prompt will return to the calling dialog a `DateTimeResolution[]`.
+ * By default the prompt will return to the calling dialog a {@link DateTimeResolution | DateTimeResolution[] }.
  */
 export class DateTimePrompt extends Prompt<DateTimeResolution[]> {
   /**
@@ -44,9 +44,9 @@ export class DateTimePrompt extends Prompt<DateTimeResolution[]> {
   /**
      * Creates a new DateTimePrompt instance.
      *
-     * @param dialogId Unique ID of the dialog within its parent `DialogSet` or `ComponentDialog`.
+     * @param dialogId Unique ID of the dialog within its parent {@link DialogSet} or {@link ComponentDialog}.
      * @param validator (Optional) validator that will be called each time the user responds to the prompt.
-     * @param defaultLocale (Optional) locale to use if `TurnContext.activity.locale` is not specified. Defaults to a value of `en-us`.
+     * @param defaultLocale (Optional) locale to use if {@link TurnContext.activity.locale} is not specified. Defaults to a value of `en-us`.
      */
   constructor (dialogId: string, validator?: PromptValidator<DateTimeResolution[]>, defaultLocale?: string) {
     super(dialogId, validator)

package/src/prompts/numberPrompt.ts

@@ -28,9 +28,9 @@ export class NumberPrompt extends Prompt<number> {
   /**
      * Creates a new NumberPrompt instance.
      *
-     * @param dialogId Unique ID of the dialog within its parent `DialogSet` or `ComponentDialog`.
+     * @param dialogId Unique ID of the dialog within its parent {@link DialogSet} or {@link ComponentDialog}.
      * @param validator (Optional) validator that will be called each time the user responds to the prompt.
-     * @param defaultLocale (Optional) locale to use if `TurnContext.activity.locale` is not specified. Defaults to a value of `en-us`.
+     * @param defaultLocale (Optional) locale to use if {@link TurnContext.activity.locale} is not specified. Defaults to a value of `en-us`.
      */
   constructor (dialogId: string, validator?: PromptValidator<number>, defaultLocale?: string) {
     super(dialogId, validator)
@@ -40,10 +40,10 @@ export class NumberPrompt extends Prompt<number> {
   /**
      * Prompts the user for input.
      *
-     * @param context [TurnContext] context for the current
+     * @param context {@link TurnContext} context for the current
      * turn of conversation with the user.
      * @param state Contains state for the current instance of the prompt on the dialog stack.
-     * @param options A [PromptOptions] object constructed
+     * @param options A {@link PromptOptions} object constructed
      * from the options initially provided in the call to Prompt.
      * @param isRetry `true` if this is the first time this prompt dialog instance
      * on the stack is prompting the user for input; otherwise, false.
@@ -65,10 +65,10 @@ export class NumberPrompt extends Prompt<number> {
   /**
      * Attempts to recognize the user's input.
      *
-     * @param context [TurnContext], context for the current
+     * @param context {@link TurnContext}, context for the current
      * turn of conversation with the user.
      * @param _state Contains state for the current instance of the prompt on the dialog stack.
-     * @param _options A [PromptOptions] object constructed
+     * @param _options A {@link PromptOptions} object constructed
      * from the options initially provided in the call to Prompt.
      * @returns A `Promise` representing the asynchronous operation.
      */