@asset-pipe/js-reader

Javascript asset feed reader

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
127May 29, 2020Jun 1, 2016Minified + gzip package size for @asset-pipe/js-reader in KB

Readme

@asset-pipe/js-reader

Greenkeeper badge

This is an internal module intended for use by other modules in the asset-pipe project.

This takes one or more asset feeds, as produced by the asset-pipe-js-writer, and produces an executable JavaScript bundle for the browser.

Data format

What we refer to as asset feeds are arrays of objects in the internal data format used by Browserify. We use this exact same data format throughout the asset-pipe project.

When Browserify resolves CommonJS modules each dependency will be read and transformed into an object which looks something like this:

{
    "id": "c645cf572a8f5acf8716e4846b408d3b1ca45c58",
    "source":
        "\"use strict\";module.exports.world=function(){return\"world\"};",
    "deps": {},
    "file": "./assets/js/bar.js"
}

Each object is emitted on a stream for each dependency. This is the asset feed.

Installation

$ npm install @asset-pipe/js-reader

Usage

Make an JavaScript bundle out of two asset feeds stored on a filesystem:

const bundleJS = require('@asset-pipe/js-reader');
const SinkFs = require('@asset-pipe/sink-fs');

const sink = new SinkFs({
    path: './assets'
});

try {
    const feedA = JSON.parse(await sink.get('a.json'));
    const feedB = JSON.parse(await sink.get('b.json'));
    const bundle = await bundleJS([feedA, feedB]);
} catch (e) {
    // handle errors
}

API

This module has the following API:

function(feeds, [options])

Supported arguments are:

  • feeds - Array - An Array of feeds.
  • options - Object - configuration.
    • options.directory { directory: '/path/to/temp/directory' } Directory to use when unpacking feed files.
    • options.sourceMaps (default: false) Specify whether to include source maps.
    • options.minify (default: false) Specify whether to minify code using uglify.
    • options.env (default: process.env.NODE_ENV || 'development') Specfies environment which is used to replace any usages of process.env.NODE_ENV with this value. This then enables dead code path elimination during bundling.

Returns a promise that resolves to a string of JavaScript code.

License

The MIT License (MIT)

Copyright (c) 2018 - Trygve Lie - post@trygve-lie.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.