Class StoryFormat

constructor

• new StoryFormat(rawSource?): StoryFormat

• Parameters

  • Optional rawSource: string

    JSONP source to initially load

  Returns StoryFormat

attributes

load

• load(rawSource): Promise<void>

• Creates the attributes property, which contains the parsed version of the format's properties, from a JSONP-formatted string. This also invokes the hydrate property of the format if defined. If the format is malformed, this will reject.

  Parameters

  • rawSource: string

    JSONP source to load

  Returns Promise<void>

  See

  https://github.com/klembot/twinejs/blob/develop/EXTENDING.md#hydration

publish

• publish(story): string

• Returns HTML for a story bound to this format.

  Parameters

  • story: Story

    Story to publish

  Returns string

toJSONP

• toJSONP(callbackName?): string

• Returns a JSONP representation of the story format's attributes.

  Parameters

  • callbackName: string = 'storyFormat'

  Returns string