checksync/dist/generate-errors-for-file.d.ts

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

import { MarkerCache, ErrorDetails, Options } from "./types";
/**
 * Generate errors for a given source file.
 *
 * Given a marker cache and a source file, this generates a sequence of the
 * various errors the source file has.
 *
 * @export
 * @param {Options} options The option uses to run checksync.
 * @param {string} file The source file for which to generate edges.
 * @param {MarkerCache} cache The marker cache to use to build the edges.
 * @returns {Iterator<MarkerEdge>} An iterator of the edges.
 */
export default function generateErrors(options: Options, file: string, cache: Readonly<MarkerCache>): Iterable<ErrorDetails>;