UNPKG

extwee

Version:

A story compiler tool using Twine-compatible formats

github.com/videlais/extwee

videlais/extwee

15 lines (14 loc) • 744 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
/** * Write a combination of Story + StoryFormat into Twine 2 HTML file. * @see {@link https://github.com/iftechfoundation/twine-specs/blob/master/twine-2-htmloutput-spec.md Twine 2 HTML Output Specification} * @function compile * @param {Story} story - Story object to write. * @param {StoryFormat} storyFormat - StoryFormat to write. * @returns {string} Twine 2 HTML based on StoryFormat and Story. * @throws {Error} If story is not instance of Story. * @throws {Error} If storyFormat is not instance of StoryFormat. * @throws {Error} If storyFormat.source is empty string. */ export function compile(story: Story, storyFormat: StoryFormat): string; import { Story } from '../Story.js'; import StoryFormat from '../StoryFormat.js';