UNPKG

1.45 kBTypeScriptView Raw
1import { Options, Result, FileCompareHandlers, FilterHandlers, CompareNameHandlers } from './types';
2export * from './types';
3/**
4 * Synchronously compares given paths.
5 * @param path1 Left file or directory to be compared.
6 * @param path2 Right file or directory to be compared.
7 * @param options Comparison options.
8 */
9export declare function compareSync(path1: string, path2: string, options?: Options): Result;
10/**
11 * Asynchronously compares given paths.
12 * @param path1 Left file or directory to be compared.
13 * @param path2 Right file or directory to be compared.
14 * @param extOptions Comparison options.
15 */
16export declare function compare(path1: string, path2: string, options?: Options): Promise<Result>;
17/**
18 * List of {@link CompareFileHandler}s included with dir-compare.
19 *
20 * See [File content comparators](https://github.com/gliviu/dir-compare#file-content-comparators) for details.
21 */
22export declare const fileCompareHandlers: FileCompareHandlers;
23/**
24 * List of {@link CompareNameHandler}s included with dir-compare.
25 *
26 * See [Name comparators](https://github.com/gliviu/dir-compare#name-comparators) for details.
27 */
28export declare const compareNameHandlers: CompareNameHandlers;
29/**
30 * List of {@link FilterHandler}s included with dir-compare.
31 *
32 * See [Glob filter](https://github.com/gliviu/dir-compare#glob-filter) for details.
33 */
34export declare const filterHandlers: FilterHandlers;
35//# sourceMappingURL=index.d.ts.map
\No newline at end of file