checksync/dist/parse-file.d.ts

A tool that allows code to be annotated across different files to ensure they remain in sync.

import { Options, FileParseResult } from "./types";
/**
 * Parse the given file and extract sync markers.
 *
 * @export
 * @param {string} file The path of the file to be parsed.
 * @param {boolean} readOnly Whether this file is considered read-only or not.
 * @param {Array<string>} comments An array of strings that specify the comment
 * syntax to look for at the start of marker tags.
 * @returns {Promise<FileParseResult>} The promise of the markers this file contains or
 * null if there were no markers or errors.
 */
export default function parseFile(options: Options, file: string, readOnly: boolean): Promise<FileParseResult>;