Module functions/transcribeStory

Const transcribeStory

• transcribeStory(story: Story, onPrompt: function, context?: any, nextChoiceId?: string, transcript?: string): Promise<string>

• Render a Story to text, prompting the user for their reactions along the way and adjusting course accordingly.

  Parameters

  • story: Story

    The list of Choice data to transcribe.

  • onPrompt: function

    A callback function that can be used to collect user input in the form of a Point.

    • • (axes: string[]): Promise<Point>

      • Parameters

        • axes: string[]

        Returns Promise<Point>

  • context: any = {}

    A persistent mutable data structure.

  • nextChoiceId: string = ""

    The id of the next Choice to transcribe.

  • transcript: string = ""

    The accumulated text of the Story.

  Returns Promise<string>