upscore

1.2.0 • Public • Published

upscore

Dependency Status

Module to provide back Underscore templates on updated files... updated-underscore.

$ npm install upscore

Usage

Provide Upscore a file path and a callback. When the file is modified the callback will be called with an Underscore template based upon the file. The default polling interval is one second, or 1,000 milliseconds, override this with Upscore's .interval property before Upscore'ing a file. Upscore'd files are automatically initialized, override this with Upscore's .initialize property.

General Example

'use strict';
 
var upscore = require("upscore");
 
/* The file below will be made into an Underscore
// template when a poll is made and a change is
// found. With default Upscore settings, as below,
// initialization will call the newTemplate function
// (this saves us unnecessary reads and templating.)
*/
 
upscore("./template.html",newTemplate);
 
function newTemplate(
  newTemp
){
  
  console.log(newTemp(data));
}

Disable Initialization

'use strict';
 
/* All future files will not be automatically
// made into Underscore templates. This will
// not change the initialization of previously
// Upscore'd files.
*/
 
var upscore = require("upscore");
 
upscore.initialize = false;

Override Polling Interval

'use strict';
 
/* This will have all future Upscore'd files
// poll for changes every 100 milliseconds.
// This will not change the polling interval
// of previously Upscore'd files.
*/
 
var upscore = require("upscore");
 
upscore.interval = 100;

Package Sidebar

Install

npm i upscore

Weekly Downloads

0

Version

1.2.0

License

MIT

Last publish

Collaborators

  • meta.ceo