Register loader functions that dynamically read, parse or otherwise transform file contents when the name of the loader matches a file extension. You can also compose loaders from other loaders.
npm install loader-cache> Register loader functions that dynamically read, parse or otherwise transform file contents when the name of the loader matches a file extension. You can also compose loaders from other loaders.
``js
var LoaderCache = require('loader-cache');
var loaders = new LoaderCache();
// register a loader for reading files
loaders.register('read', function(fp) {
return fs.readFileSync(fp, 'utf8');
});
// register a loader for parsing YAML
loaders.register('yaml', function(fp) {
return YAML.safeLoad(fp);
});
// create a loader from any combination of other
// registered loaders and functions.
loaders.register('dataLoader', ['read', 'yaml'], function(data) {
if (!data) throw new Error('no data!');
return data;
});
// pass a loader stack or the name of a loader to .compose() `
// to create the actual function to be used for loading
var fn = loaders.compose('dataLoader');
var data = fn('config.yml');
Install with npm
`sh`
$ npm i loader-cache --save
Create a new instance of LoaderCache
Example
`js`
var LoaderCache = require('loader-cache');
var loaders = new LoaderCache();
Register an iterator function of the given type. Types typically represent a kind of flow-control, like sync, promise, stream, async etc.
Params
* type {String}options
* {Object}fn
* {Function}: The actual iterator function.returns
* {Object}
Example
`jsstack
loader.iterator('sync', function(stack) {
// is the loader stack (array) to iterate overargs
// each item in array is a loader function
return function(args) {
// is the arguments passed to the loaders`
}
});
Register a loader. The first argument is the name of the loader to register.
Params
* name {String}options
* {Object}fns
* {Function|Array}: One or more loader functions or names of other registered loaders.returns
* {Array}
Example
`js`
// create a loader from other loaders.
loaders.loader('foo', ['bar', 'baz']);
// pass a function
loaders.loader('foo', function(patterns, options) {
return glob.sync(patterns, options);
});
// combination
loaders.loader('foo', ['bar', 'baz'], function(patterns, options) {
return glob.sync(patterns, options);
});
Compose the actual load function from a loader stack.
Params
* name {String}: The name of the loader stack to use.options
* {Object}stack
* {Array|Function}: Additional loader names or functions.returns
* {Function}
Example
`js`
var fn = loaders.compose('foo');
// load some files
var files = fn('*.txt');
* config-cache: General purpose JavaScript object storage methods.
* cache-base: Generic object cache for node.js/javascript projects.
* engine-cache: express.js inspired template-engine manager.
* helper-cache: Easily register and get helper functions to be passed to any template engine or node.js… more
* option-cache: Simple API for managing options in JavaScript applications.
* parser-cache: Cache and load parsers, similiar to consolidate.js engines.
Install dev dependencies:
`sh`
$ npm i -d && npm test
Please help improve code coverage by adding unit tests.
`js``
-----------------|-----------|-----------|-----------|-----------|
File | % Stmts |% Branches | % Funcs | % Lines |
-----------------|-----------|-----------|-----------|-----------|
loader-cache/ | 91.27 | 82.35 | 85.71 | 92.5 |
index.js | 91.27 | 82.35 | 85.71 | 92.5 |
-----------------|-----------|-----------|-----------|-----------|
All files | 91.27 | 82.35 | 85.71 | 92.5 |
-----------------|-----------|-----------|-----------|-----------|
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue
Jon Schlinkert
+ github/jonschlinkert
+ twitter/jonschlinkert
Copyright © 2015 Jon Schlinkert
Released under the MIT license.
*
_This file was generated by verb-cli on June 29, 2015._