@akumzy/fs-watcher
v0.3.4
Published
Nodejs fs watcher with recursive watch support.
Downloads
70
Maintainers
Readme
fs-watcher
fs-watcher
is based on this awesome Go
package github.com/radovskyb/watcher for watching for files or directory changes (recursively or non recursively) without using filesystem events, which allows it to work cross platform consistently.
@akumzy/fs-watcher
is made possible with the help of an IPC packages for Node and Go ipc-node-go and fs-watcher-go
Installation
npm install @akumzy/fs-watcher
//or
yarn add @akumzy/fs-watcher
Features
- Customizable polling interval.
- Filter Events.
- Watch folders recursively or non-recursively.
- Choose to ignore hidden files.
- Choose to ignore specified files and folders.
- Notifies with some basic informations about the file that the event is based on. e.g
name
modTime
path
oldPath
if the event is rename or moveisDir
mode
- Notifies the full path of the file that the event is based on or the old and new paths if the event was a
rename
ormove
event. - List the files being watched.
Example
// using require method
const { default: Watcher, Op } = require('@akumzy/fs-watcher')
// or with es modules
import Watcher, { Op } from '@akumzy/fs-watcher'
const w = new Watcher({
path: '/home/akumzy/Documents', // path you'll like to watch
debug: true,
filters: [Op.Create, Op.Write, Op.Rename], // changes to watch default is all
recursive: true // to watch the specified path recursively
})
// start watching
w.start((err, files) => {
if (err) {
console.log(err)
return
}
console.log('f', files)
;(async () => {
try {
let res = await w.ignore('/home/akumzy/Music/Culture')
console.log('Ignore was ', res ? 'successful' : 'total bs')
await w.addRecursive('/home/akumzy/Music')
} catch (error) {
console.log(error)
}
})()
})
w.onChange('create', file => {
console.log(file)
})
w.onChange('write', file => {
console.log(file)
})
w.onChange('rename', file => {
console.log(file)
})
w.onAll((event, file) => {
console.log(event, file)
})
w.onError(console.log)
API
Watcher(option: WatcherOption)
WatcherOption
interval: number;
The polling interval in milliseconds. default is 100msignoreHiddenFiles: boolean;
to ignore hidden filesignorePaths: string[];
Array of paths to be igored at startupfilters: Op[];
changes to subscrib to.binPath?: string;
For any reason you want to keep the binary a different locationpath: string;
path to watchrecursive: true;
if to watch the specified path recursivelydebug: false;
If you're ok with logging from child_processfilterHooks: FilterHook[];
Extra filter hooks to be added watcherFilterHook
reg: string;
reg is simply a plain regular expression pattern eg:^~$
Good/^~$/
Bad.new RegExp('^~$')
Very bad.useFullPath: boolean
If to use the file full path or just the file name
methods
start(cb: (err: any, info: EventInfo | FileInfo[]) => void): void;
start the watchergetWatchedFiles(): Promise<FileInfo[]>;
This return all the watched files per cycle.onChange(event: 'create' | 'remove' | 'rename' | 'chmod' | 'move' | 'write', cb: (file: FileInfo) => void): this;
Listen to any change event you want to.onAll(cb: (event: string, file: FileInfo) => void): this;
Listens for all change eventsonError(cb: (error: any) => void): this;
Once this event emits it's very likely that theWatcher
process has been closed. so is now left for to check and restartstop(): void;
stop theWatcher
addRecursive(path: string): Promise<boolean>;
adds either a single file or directory recursively to the file list.add(path: string): Promise<boolean>;
Add path to watchremove(path: string): Promise<boolean>;
unwatch pathremoveRecursive(path: string): Promise<boolean>;
unwatch path recursivelyignore(paths: string[]): Promise<boolean>;
Ignore path
FileInfo
size: number;
File size in bytes.modTime: Date;
File Last modification.path: string;
File absolute pathname: string;
File name with extention if it's not a directoryoldPath?: string;
empty string if event is notrename
ormove
isDir: boolean;
File type which will be true it's a directorymode?: number;
File mode
Events
Op {
Create,
Write,
Remove,
Rename,
Chmod,
Move
}
All credits goes to radovskyb for creatng this github.com/radovskyb/watcher awesome Go package.