UNPKG

screenplay-js

Version:

A modern Typescript, Foutain screenplay parser. Convert Final Draft (.fdx) files to Fountain, and then parse Fountain markdown to HTML.

31 lines (30 loc) 967 B
import { IParserOptions, IScriptJSON } from '../interfaces'; declare class Parser { options: IParserOptions; constructor(options?: IParserOptions); /** * Parse a screenplay written in .fountain and output meta results * for the screenplay. * * @param { String } script - Text of the screenplay * @param { Object } _options - Options to pass into the parse function */ parse(script: string, _options?: IParserOptions): IScriptJSON; /** * Loosely paginate parsed screenplays. New pages will occur when a page * break is identified in the script. */ paginate(script_html: string[], lpp?: string): { pages: any; pages_html: any; }; /** * Match and replace string elements with appropriate * inline CSS styles. * * @param { String } s */ lexer(s: string): string | undefined | null; } declare const FountainParser: Parser; export { FountainParser };