dir-compare

property distinctBrokenLinks

distinctBrokenLinks: number;

• Number of broken links with same name appearing in both path1 and path2 (leftBrokenLinks + rightBrokenLinks + distinctBrokenLinks)

property leftBrokenLinks

leftBrokenLinks: number;

• Number of broken links only in path1

property rightBrokenLinks

rightBrokenLinks: number;

• Number of broken links only in path2

property totalBrokenLinks

totalBrokenLinks: number;

• Total number of broken links

property compareAsync

compareAsync: CompareFileAsync;

property compareSync

compareSync: CompareFileSync;

property defaultNameCompare

defaultNameCompare: CompareNameHandler;

• Compares file or directory names using the 'strcmp' function. It is used if Options.compareNameHandler is not specified.

property date1

date1?: Date;

• Left entry modification date (stat.mtime). Is undefined if missing on the left side.

property date2

date2?: Date;

• Right entry modification date (stat.mtime). Is undefined if missing on the right side.

property level

level: number;

• Depth level relative to root dir.

property name1

name1?: string;

• Left file/directory name. Is undefined if missing on the left side.

property name2

name2?: string;

• Right file/directory name. Is undefined if missing on the right side.

property path1

path1?: string;

• Path not including file/directory name; can be relative or absolute depending on call to compare(). Is undefined if missing on the left side.

property path2

path2?: string;

• Path not including file/directory name; can be relative or absolute depending on call to compare(). Is undefined if missing on the right side.

property permissionDeniedState

permissionDeniedState: PermissionDeniedState;

• Permission related state of left/right entries.

property reason

reason: Reason;

• Provides reason when two identically named entries are distinct.

property relativePath

relativePath: string;

• Path relative to the root directory of the comparison.

property size1

size1?: number;

• Left file size. Is undefined if missing on the left side.

property size2

size2?: number;

• Right file size. Is undefined if missing on the right side.

property state

state: DifferenceState;

• See DifferenceState

property type1

type1: DifferenceType;

• Type of left entry. Is undefined if missing on the left side.

property type2

type2: DifferenceType;

• Type of right entry. Is undefined if missing on the right side.

index signature

[key: string]: any;

• Any property is allowed if default result builder is not used.

property absolutePath

absolutePath: string;

property isBrokenLink

isBrokenLink: boolean;

property isDirectory

isDirectory: boolean;

property isPermissionDenied

isPermissionDenied: boolean;

• True when this entry is not readable. This value is set only when Options.handlePermissionDenied is enabled.

property isSymlink

isSymlink: boolean;

property lstat

lstat: fs.Stats;

property name

name: string;

property origin

origin: EntryOrigin;

• Whether this entry originated from the left or the right dir.

property path

path: string;

property stat

stat: fs.Stats;

property defaultFileCompare

defaultFileCompare: CompareFileHandler;

• Compares files based on their binary content.

  This is the default file content comparator. It is used when Options.compareContent is true and custom file comparator is not specified (ie. Options.compareFileSync or Options.compareFileAsync are 'undefined').

property lineBasedFileCompare

lineBasedFileCompare: CompareFileHandler;

• Compares files line by line.

  These additional options are available: * ignoreLineEnding - true/false (default: false) - Ignore cr/lf line endings * ignoreWhiteSpaces - true/false (default: false) - Ignore white spaces at the beginning and ending of a line (similar to 'diff -b') * ignoreAllWhiteSpaces - true/false (default: false) - Ignore all white space differences (similar to 'diff -w') * ignoreEmptyLines - true/false (default: false) - Ignores differences caused by empty lines (similar to 'diff -B')

property defaultFilterHandler

defaultFilterHandler: FilterHandler;

• Uses minimatch to include/ignore files based on Options.includeFilter and Options.excludeFilter. It is used if Options.filterHandler is not specified.

property brokenLinks

brokenLinks: BrokenLinksStatistics;

• Stats about broken links.

property distinct

distinct: number;

• Number of distinct entries.

property distinctDirs

distinctDirs: number;

• Number of distinct directories.

property distinctFiles

distinctFiles: number;

• Number of distinct files.

property equal

equal: number;

• Number of equal entries.

property equalDirs

equalDirs: number;

• Number of equal directories.

property equalFiles

equalFiles: number;

• Number of equal files.

property left

left: number;

• Number of entries only in path1.

property leftDirs

leftDirs: number;

• Number of directories only in path1.

property leftFiles

leftFiles: number;

• Number of files only in path1.

property permissionDenied

permissionDenied: PermissionDeniedStatistics;

• Stats about entries that could not be accessed.

property right

right: number;

• Number of entries only in path2.

property rightDirs

rightDirs: number;

• Number of directories only in path2.

property rightFiles

rightFiles: number;

• Number of files only in path2

property symlinks

symlinks?: SymlinkStatistics;

• Statistics available if 'compareSymlink' options is used.

index signature

[key: string]: any;

• Any property is allowed if default result builder is not used.

property compareContent

compareContent?: boolean;

• Compares files by content. Defaults to 'false'.

  Usually one of compareSize or compareContent options has to be activated. Otherwise files are compared by name disregarding size or content.

property compareDate

compareDate?: boolean;

• Compares files by date of modification (stat.mtime). Defaults to 'false'.

  Also see Options.dateTolerance.

property compareFileAsync

compareFileAsync?: CompareFileAsync;

• Extension point used to perform async file content comparison.

  See [File comparators](https://github.com/gliviu/dir-compare#file-content-comparators).

property compareFileSync

compareFileSync?: CompareFileSync;

• Extension point used to perform sync file content comparison.

  See [File comparators](https://github.com/gliviu/dir-compare#file-content-comparators).

property compareNameHandler

compareNameHandler?: CompareNameHandler;

• Extension point used to compare files or directories names.

  See [Name comparators](https://github.com/gliviu/dir-compare#name-comparators).

property compareSize

compareSize?: boolean;

• Compares files by size. Defaults to 'false'.

  Usually one of compareSize or compareContent options has to be activated. Otherwise files are compared by name disregarding size or content.

property compareSymlink

compareSymlink?: boolean;

• Compares entries by symlink. Defaults to 'false'.

  If this option is enabled two entries must have the same type in order to be considered equal. They have to be either two fies, two directories or two symlinks.

  If left entry is a file and right entry is a symlink, they are considered distinct disregarding the content of the file.

  Further if both entries are symlinks they need to have the same link value. For example if one symlink points to '/x/b.txt' and the other to '/x/../x/b.txt' the symlinks are considered distinct even if they point to the same file.

property dateTolerance

dateTolerance?: number;

• Two files are considered to have the same date if the difference between their modification dates fits within date tolerance. Defaults to 1000 ms.

property excludeFilter

excludeFilter?: string;

• File/directory name exclude filter. Comma separated minimatch patterns. See [Glob patterns](https://github.com/gliviu/dir-compare#glob-patterns).

property filterHandler

filterHandler?: FilterHandler;

• Extension point used to control which files or directories should be included in the comparison.

  See [Glob filter](https://github.com/gliviu/dir-compare#glob-filter).

property handlePermissionDenied

handlePermissionDenied?: boolean;

• Handle permission denied errors. Defaults to 'false'.

  By default when some entry cannot be read due to EACCES error the comparison will stop immediately with an exception.

  If handlePermissionDenied is set to true the comparison will continue when unreadable entries are encountered.

  Offending entries will be reported within Difference.permissionDeniedState, Difference.reason and Result.permissionDenied.

  Lets consider we want to compare two identical folders A and B with B/dir2 being unreadable for the current user.

  A                    B
  ├── dir1             ├── dir1
  ├──── file1          ├──── file1
  ├── dir2             ├── dir2 (permission denied)
  └─────file2          └─────file2

  Result.diffSet will look like:

  |relativePath |path1 |path2 | state |reason |permissionDeniedState| |--------------|---------|---------|------------|------------------------|---------------------| |[/] |dir1 |dir1 |equal | | | |[/dir1] |file1 |file1 |equal | | | |[/] |dir2 |dir2 |distinct | permission-denied |access-error-right | |[/dir2] |file2 |missing |left | | |

  And Result.permissionDenied statistics look like

  {
    leftPermissionDenied: 0,
    rightPermissionDenied: 1,
    distinctPermissionDenied: 0,
    totalPermissionDenied: 1
  }

property ignoreCase

ignoreCase?: boolean;

• Ignores case when comparing names. Defaults to 'false'.

property includeFilter

includeFilter?: string;

• File name filter. Comma separated minimatch patterns. See [Glob patterns](https://github.com/gliviu/dir-compare#glob-patterns).

property noDiffSet

noDiffSet?: boolean;

• Toggles presence of diffSet in output. If true, only statistics are provided. Use this when comparing large number of files to avoid out of memory situations. Defaults to 'false'.

property resultBuilder

resultBuilder?: ResultBuilder;

• Extension point used for constructing the Result object.

  See [Result builder](https://github.com/gliviu/dir-compare#result-builder).

property skipEmptyDirs

skipEmptyDirs?: boolean;

• Ignore empty directories. Defaults to 'false'.

property skipSubdirs

skipSubdirs?: boolean;

• Skips sub directories. Defaults to 'false'.

property skipSymlinks

skipSymlinks?: boolean;

• Ignore symbolic links. Defaults to 'false'.

index signature

[key: string]: any;

• Properties to be used in various extension points ie. result builder.

property distinctPermissionDenied

distinctPermissionDenied: number;

• Number of forbidden entries with same name appearing in both path1 and path2 (leftPermissionDenied + rightPermissionDenied + distinctPermissionDenied)

property leftPermissionDenied

leftPermissionDenied: number;

• Number of forbidden entries found only in path1

property rightPermissionDenied

rightPermissionDenied: number;

• Number of forbidden entries found only in path2

property totalPermissionDenied

totalPermissionDenied: number;

• Total number of forbidden entries

property diffSet

diffSet?: DiffSet;

• Detailed list of comparison results. Present if Options.noDiffSet is false.

property differences

differences: number;

• Total number of differences (distinct+left+right).

property differencesDirs

differencesDirs: number;

• Total number of different directories (distinctDirs+leftDirs+rightDirs).

property differencesFiles

differencesFiles: number;

• Total number of different files (distinctFiles+leftFiles+rightFiles).

property same

same: boolean;

• True if directories are identical.

property total

total: number;

• Total number of entries (differences+equal).

property totalDirs

totalDirs: number;

• Total number of directories (differencesDirs+equalDirs).

property totalFiles

totalFiles: number;

• Total number of files (differencesFiles+equalFiles).

property differencesSymlinks

differencesSymlinks: number;

• Total number of different links (distinctSymlinks+leftSymlinks+rightSymlinks).

property distinctSymlinks

distinctSymlinks: number;

• Number of distinct links.

property equalSymlinks

equalSymlinks: number;

• Number of equal links.

property leftSymlinks

leftSymlinks: number;

• Number of links only in path1.

property rightSymlinks

rightSymlinks: number;

• Number of links only in path2

property totalSymlinks

totalSymlinks: number;

• Total number of links (differencesSymlinks+equalSymlinks).