OptiCoreWatcher

OptiCoreWatcher is a lightweight, fully TypeScript-based file and directory watcher designed for OptiCoreJs and also Node.js projects. It helps monitor code and environment files and automatically triggers actions or commands on changes, deletions, or creations.

Table of Contents

• Installation
• Usage
  • Initialization
  • Start Process
  • Start Restart
  • Watch Directories
  • Watch Files
  • Run
• API Reference
• Dependencies
• Security Issues
• Contributing
• License
• About

Installation

npm install opticore-watcher

Usage

Initialization

import { OptiCoreWatcher } from 'opticore-watcher';

const watcher = new OptiCoreWatcher();
watcher.run();

Start Process

watcher.startProcess();

Start Restart

watcher.restart();

Watch Directories

watcher.watchDirectory();

Watch Files

watcher.watchFile();

Run

watcher.run();

API Reference

Interface: IWatcherOptions

interface IWatcherOptions {
  paths: string[];
  recursive?: boolean;
  extensions?: string[];
  command?: string;
  ignore?: string[];
}

Dependencies

• TypeScript
• Built-in modules: fs, path, child_process

Security Issues

https://github.com/guyzoum77/opticore-watcher/issues

Contributing

OptiCore Router Module is an Open Source, so if you would like to contribute, you're welcome. Clone repository and open pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details

About

OptiCore watcher is led by Guy-serge Kouacou and supported by Guy-serge Kouacou