Skip to content

Latest commit

 

History

History
47 lines (37 loc) · 1.36 KB

README.md

File metadata and controls

47 lines (37 loc) · 1.36 KB

fs-synchronizer

NPM version build status Test coverage npm download

Recursively find files in folder and extract file informations.

Installation

$ npm i fs-synchronizer

Usage

import { FileSynchronizer } from 'fs-synchronizer';
const sync = new FileSynchronizer({
  root: 'test-utils',
  maxDepth: 2,
  patterns: [{ type: 'include', pattern: 'a*' }],
});

sync.on('file', (fileInfo) => {
  console.log(`Found file: ${fileInfo.filename}`);
});
sync.on('excluded-file', (fileInfo) => {
  console.log(`Excluded file: ${fileInfo.filename}`);
});
sync.on('end', () => {
  console.log('Finished walking');
});
await sync.walk();

License

MIT