watch-dir-safe v1.0.2

Watch a directory for changes.

Provides a simplified wrapper around chokidar for watching a directory.

Installation

yarn add watch-dir-safe

npm install watch-dir-safe

API

Usage

import watchDir from "watch-dir-safe";

const watcher = watchDir("/path/to/dir");

watcher.onReady(() => {
  console.log(`Ready`);
}).onAdd((path: string) => {
  console.log(`Added ${path}`);
}).onChange((path: string) => {
  console.log(`Changed ${path}`);
}).onRemove((path: string) => {
  console.log(`Removed ${path}`);
}).onAddDir((path: string) => {
  console.log(`Added dir ${path}`);
}).onRemoveDir((path: string) => {
  console.log(`Added dir ${path}`);
});

// To stop watching:
watcher.stop();

Types

import watchDir, { Watcher, EventCallback } from "watch-dir-safe";

function watchDir(path: string): Watcher;

type EventCallback = (path: string) => void;

type Watcher = {
  onAdd: (cb: EventCallback) => Watcher;
  onRemove: (cb: EventCallback) => Watcher;
  onChange: (cb: EventCallback) => Watcher;
  onAddDir: (cb: EventCallback) => Watcher;
  onRemoveDir: (cb: EventCallback) => Watcher;
  onReady: (cb: () => void) => Watcher;
  stop: () => Promise<boolean>;
}

• chokidar: A neat wrapper around node.js fs.watch / fs.watchFile / fsevents.

• @bconnorwhite/bob: undefined

MIT

Related Packages

• fs-safe: A simple fs wrapper that doesn't throw
• watch-file-safe: Watch a file for changes
• read-dir-safe: Read directories recursively or non-recursively
• write-dir-safe: Create directories and their parents recursively
• remove-dir-safe: Remove directories recursively or non-recursively