sents
    TypeScript icon, indicating that this package has built-in type declarations

    0.3.2 • Public • Published

    Test

    Filesystem watcher that uses fs.watch and friends (i.e., no polling). This is the library—check out sents-cli to use this on the command-line.

    Features

    • Zero dependencies 🍩 and no native code
    • Supports macOS, Linux, Windows (and probably others) via the same API
    • Supports hard links (announces changes at all places inode is found)
    • Handles awkward renames on case-insensitive filesystems ("foo" => "FOO" is announced)

    It does not support some features:

    • Following symlinks
    • Renames (instead announce delete/add—what do renames mean in a world of hard links?)
    • Watching across volumes
    • And it should not be used on network shares (they need polling, every watcher hates these)

    Usage

    Basic usage:

    import buildWatcher from 'sents';
    
    // Create a watcher by passing a directory name ("." for the current dir).
    const watcher = buildWatcher('.');
    
    // Type can be 'add', 'change', or 'remove'.
    watcher.on('raw', (filename, type, ino) => {
      console.warn(type.toUpperCase(), filename, ino);
    });
    
    // If the watcher emits an error, it's no longer usable.
    watcher.on('error', (e) => {
      console.warn('got error', e);
    });
    
    // Call .close() to shut down the watcher.
    setTimeout(() => {
      watcher.close();
    }, 60 * 1000);

    Note that this watches a single directory, and directly watching files is not supported.

    The only events emitted by sents are "ready", "raw", and "error".

    Options

    This also supports some options:

    const watcher = buildWatcher('.', {
      dotfiles: false,
      filter: (rel) => true,
      delay: 1000,
    });
    • dotfiles controls whether files starting with '.' are returned (default false)
    • filter allows filtering of the results (return true to include, default includes all)
      • When directories are passed, they'll end with path.sep (i.e., "/" most places); if you filter them, you'll never be asked or notified about their subdirectories
      • This should be a pure function—don't change results over time—otherwise, you're gonna have a bad time
    • delay allows you to delay and aggregate changes by ms (if unset, uses a microtask)

    Notes

    On macOS and Windows, watching a whole directory subtree is fairly cheap. On Linux and other platforms, this package installs a watcher on every subdirectory. Keep this in mind when building tools using sents—be sure to use filter to limit what you're watching.

    Ready Check

    If you don't want to get all initial updates (i.e., the first scan of files) then you do either of:

    await watcher.ready;
    watcher.once('ready', () => {...});

    Glob Support

    This doesn't have glob support or any built-in filtering aside the controls above. If you want to write a command-line tool or similar, you should build a filter function that supports globs. Check out sents-cli.

    Files Only

    Technically this package isn't a file watcher, it's a directory watcher (most files watchers are). It's not more efficient to watch single files than it is a whole directory (since it has to be watched in case the file is removed). If you just want to watch a small number of files for changes, be sure to allow them specifically in filter, while ignoring all other files or directories.

    Dependents (1)

    Install

    npm i sents

    DownloadsWeekly Downloads

    0

    Version

    0.3.2

    License

    Apache-2.0

    Unpacked Size

    60 kB

    Total Files

    12

    Last publish

    Collaborators

    • samthor