Features

• It does not depend on rsync
• Asynchronous and super fast with files' stat cache
• Extremely lightweight with no dependencies – 2.3kB!
• Fully tested on Linux, Mac and Windows
• Added copy-on-write support for file systems that support it (see COPYFILE_FICLONE)

Additionally, this module is delivered as:

• ES Module: dist/reflect.es.js
• CommonJS: dist/reflect.cjs.js

Install

$ npm install @alumna/reflect

Usage

1import reflect from '@alumna/reflect';
2
3let { res, err } = await reflect({
4
5	src: 'src/',
6
7	dest: 'dest/',
8
9	// (OPTIONAL) Default to 'true'
10	recursive: true,
11
12	// (OPTIONAL) Default to 'true'
13	// Delete in dest the non-existent files in src
14	delete: true,
15
16	// (OPTIONAL)
17	// Array with files and folders not to reflect
18	exclude: [ "skip-this-file.txt", "skip/this/directory" ],
19
20	// (OPTIONAL)
21	// Seconds of time to sync with (for example, 7200, only sync last 2 hours of changes)
22	modified_within: null,
23
24	// (OPTIONAL)
25	// Only sync files that are newer in the source (ie, destination files that have been updated won't be overwritten)
26	only_newer: false,
27
28	// (OPTIONAL)
29	// Disable COPYFILE_FICLONE if supported by file system, see more info:
30	// https://nodejs.org/docs/latest-v17.x/api/fs.html#fscopyfilesrc-dest-mode-callback
31	file_clone: true,
32
33});
34
35if ( err )
36	console.error( err )
37
38else
39	console.log( res ) // Directory "src/" reflected to "dest/"