Skip to content

IonicaBizau/require-dir-watch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

require-dir-watch

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

Buy Me A Coffee

Reimport the files from a directory when they are being updated.

☁️ Installation

# Using npm
npm install --save require-dir-watch

# Using yarn
yarn add require-dir-watch

πŸ“‹ Example

const path = require("path");
const requireDirWatch = require("require-dir-watch");

// Define the directory to watch
const functionsDir = path.join(__dirname, "functions");

// Load and watch the functions directory
const functions = requireDirWatch(functionsDir, {
    onError: err => console.error("[ERROR]", err),
    onCreate: (name, module) => console.log(`[CREATE] Module '${name}' loaded:`, module),
    onUpdate: (name, module) => console.log(`[UPDATE] Module '${name}' reloaded:`, module),
    onDelete: name => console.log(`[DELETE] Module '${name}' removed.`)
});

// Periodically invoke a function if it exists and log the function map
setInterval(() => {
    if (typeof functions.sum === "function") {
        console.log("sum(35, 7) =", functions.sum(35, 7));
    } else {
        console.log("Function 'sum' is not available.");
    }
    console.log("Current modules:", functions);
}, 1000);

πŸ“ Documentation

requireDirWatch(directoryPath, [options], [options.onError], [options.onCreate], [options.onUpdate], [options.onDelete])

Reimport the files from a directory when they are being updated.

Params

  • String directoryPath: The directory to watch.
  • Object [options]: Configuration options.
  • Function [options.onError]: A callback function to handle errors.
  • Function [options.onCreate]: A callback function when a file is created.
  • Function [options.onUpdate]: A callback function when a file is updated.
  • Function [options.onDelete]: A callback function when a file is deleted.

Return

  • Object An object with file base names as keys and their exports as values.

❓ Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. πŸ›
  3. For direct and quick help, you can use Codementor. πŸš€

πŸ˜‹ How to contribute

Have an idea? Found a bug? See how to contribute.

πŸ’– Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like πŸš€

  • Buy me a bookβ€”I love books! I will remember you after years if you buy me one. 😁 πŸ“–

  • PayPalβ€”You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍡

  • Support me on Patreonβ€”Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoinβ€”You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❀️

πŸ“œ License

MIT © Ionică Bizău

About

Reimport the files from a directory when they are being updated.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors