source-extractor

1.0.0 • Public • Published

JS module interpreter

Build Status Coverage Status

Get the exports object from a stream, buffer, string or object representing a js module. see usage.

Installation

With npm:

npm install -save extract

extract is meant to be used on a commonjs environment (or es6 through transpilation) such as the one node provides, is has no browser support

Usage

let extract = require('extract');
 
// from a string source
let source =  ```
module.exports = {
  name: 'Mike Wazowski'
};
```;
 
console.log(extract.from(source).name) // Mike Wazowski
 
// extracting specific keys from a string source
console.log(extract.from(source, 'name')); // Mike Wazowski
 
// Extracting from a readable Stream
let fs = require('fs');
 
extract
  .from(fs.createReadStream('path/to/file')) // extracting from streams returns a Promise
  .then((result) => {
    // assuming the content of the file is the same as source.
    console.log(result.name) // Mike Wazowski
  });
 
/**
 * Notes:
 *
 * - Extracting from Buffer and Objects works the same way as extracting from strings.
 * - Extracting from streams works with any kind of readable streams, such as http responses, read file streams, etc..
 */

Documentation

extract
.from(String|Buffer|Object source, String key='') -> any
Extracting from a string, buffer or object will retrieve the exported object of that module. If key is provided, then the key property of the exported object will be returned, the whole exported object will be returned otherwise.
.from(stream.Readable source, String key='' ) -> Promise.{any}
Extracting from a readable stream works the same as extracting from a string but instead of returning the exported object itself, it returns a promise which will pass on the exports when resolve.

Why?

The main goal of the package is to interpret js packages bundled on the run when on development. An example of such case would be server side rendering, when de server bundle is being watched and re-bundled when a file changes, we need to reinterpret the js bundle (which can come in any kind of format) on the run.

Package Sidebar

Install

npm i source-extractor

Weekly Downloads

5

Version

1.0.0

License

MIT

Last publish

Collaborators

  • alejor