A modern and easy-to-use JavaScript/TypeScript toolkit that provides utilities such as file watching, scheduling, and more.

Installation

npm install @atosjs/toolkit

Usage

Importing the Library

For CommonJS:

const { Watcher } = require("@atosjs/toolkit");

For ES Modules:

import { Watcher } from "@atosjs/toolkit";

Example: File Watcher

const { Watcher } = require("@atosjs/toolkit");

// Create a watcher monitoring two folders: ./src and ./tests
const watcher = new Watcher(["./src", "./tests"], {
  ignored: [
    "node_modules/**", // ignore node_modules
    "dist/**",         // ignore build output
  ],
  persistent: true,   // keep the watcher alive
  usePolling: false,  // rely on system events instead of polling
});

// Fired when a new file is created
watcher.on("add", (file) => {
  console.log("File added:", file);
});

// Fired when a file is modified
watcher.on("change", (file) => {
  console.log("File changed:", file);
});

// Fired when a file is removed
watcher.on("remove", (file) => {
  console.log("File removed:", file);
});

// Fired when an error occurs
watcher.on("error", (err) => {
  console.error("Watcher error:", err);
});

// Example: close the watcher after 60 seconds
setTimeout(() => {
  watcher.close();
  console.log("Watcher closed.");
}, 60000);

Watcher Events

• add → Triggered when a new file is created inside the watched directories. Example: creating a new index.ts file.

• change → Triggered when an existing file is modified. Example: saving changes to app.js.

• remove → Triggered when a file is deleted. Example: removing old.test.js from the project.

• error → Triggered when an internal error occurs in the watcher. Example: permission issues or invalid paths.

Links

• Website | Documentation | Discord
• GitHub
• NPM, Latest version: v1.0.0.