extwee/types/Config/reader.d.ts

A story compiler tool using Twine-compatible formats

/**
 * Read a JSON file and return its contents.
 * @param {string} path Path to the JSON file.
 * @returns {object} Parsed JSON object.
 * @throws {Error} If the file does not exist.
 * @throws {Error} If the file is not a valid JSON file.
 * @example
 * const contents = reader('test/Config/files/valid.json');
 * console.log(contents); // {"story-format": 'Harlowe', "story-title": "My Story"}
 */
export function reader(path: string): object;