1.0.2 • Published 8 years ago

renderable v1.0.2

Weekly downloads
5
License
MIT
Repository
github
Last release
8 years ago

renderable

A tiny file cache module, based on buffers, under the MIT licence

Install

npm install renderable

Usage

var renderable;

renderable = require('renderable');

renderable.register(paths)

// registers a single file, if needed
renderable.register([__filename])
    .then(function() {
        console.log('registered');
    });

// registers all files matching a glob mask, if needed
// please refer to https://www.npmjs.com/package/glob
renderable.register([__filename])
    .then(function() {
        console.log('registered');
    });

renderable.render(parser, paths)

var parser;

parser = function(buffer, filename) {
    return {
        render: function() {
            return buffer.toString();
        }
    };
};

// registers a single file, if needed
// registers a renderer, based on filename & parser, if needed
// renders
renderable.render(parser, paths)
    .then(function(rendered) {
        console.log(rendered);
    });

Example

https://github.com/Lcfvs/renderable-html#renderable-html