@iobxt/objectifiler v1.1.2

@iobxt/objectifiler

A handy exporter module which aims to alevate dev effort.

Installation

npm i @iobxt/objectifiler

Usage

Once the package has been installed you can drop it into an index.js file like so;

const objectifiler = require("@iobxt/objectifiler");

module.exports = objectifiler(__dirname);

When the index.js file is consumed, all the files and directories will be exported as an object.

Description

Disclaimer: This was a quick braindump.

This thing iterates over files in the provided directiory and exports them as an object. You may also provide a configuration object which will be used to configure each module, provided the module has an init function.

You can use this exporter one of two ways.

drop it into your index file and it will try to export the modules in the directory provided.

if your modules need to be initialised it will call the init function of each, passing in the config you have provided. It will try to match up an object in the config with the name of the file. You can also export the module with a name variable if you want the two to be different. if you dont want to initialise each module, you can just drop it in and it will export an object with all your files.

Usage

Given the following directory sructure;

src
  without
    foobar
      foo.js
    bar.js
  foo.js
index.js

and the top level index.js looks like this;

const objectifier = require("objectifier");

module.exports = objectifier(__dirname);

Upon importing src like this;

const foo = require("./src");

You should have an object that looks like this;

{
  without: {
    foobar: {
      foo: () => {}
    },
    bar: () => {}
  },
  foo: () => {}
}