@upsect/seeker

Node utility to check if a module is installed, and optionally fall back to another module if it's missing.

Usage no npm install needed!

<script type="module">
  import upsectSeeker from 'https://cdn.skypack.dev/@upsect/seeker';
</script>

README


seeker

Seeker is a Node.js utility for effortlessly requiring one or many modules, whether they exist or not. Require a module and optionally fall back to another module if it's missing, or require a directory of modules and get all of their exports conveniently organized by file name. Perfect for local development in a team environment, and for projects that frequently require batches of modules.

Install

% npm install @upsect/seeker

API

.import({ module: [ list ]})

  • list <string[]> list of module names or paths

Returns the first module that resolves, otherwise returns null.

const Seeker = require('seeker');

const Module = Seeker.import({ module: ['./module1', 'module2']});

.import({ index: [ path ]})

  • path <string> path to modules directory

Returns an object with module exports, otherwise returns null. Supports CJS modules that export a function, array, plain object, or class. Index.js and dot files are ignored. Refer to the test folder for examples.

const Seeker = require('seeker');

const Index = Seeker.import({ index: './my_modules' });