images-to-less-variables v0.0.6

images-to-less-variables

A simple utility for generating Less variables for images.

Installation

Install from NPM:

npm install images-to-less-variables

Usage

To generate Less variables containing 64-bit encoded images, the module's function can be called. A promise is returned and an array containing the variables is passed to handlers:

var createImageVariables = require('images-to-less-variables');

createImageVariables( '*.png' ).then( function( variables ) {
	console.log( variables[0].name );
	console.log( variables[0].length );
	console.log( variables[0].value );
} );

Alternatively, the variables can be written directly to an optional output file:

var createImageVariables = require('images-to-less-variables');

createImageVariables( '*.png', { dest: 'image-variables.less' } );

In addition, a prefix can be optionally prepended to each variable name. This is sometimes useful to avoid collisions with other variables.

var createImageVariables = require('images-to-less-variables');

createImageVariables( '*.png', { prefix: 'my-ns-' } );

By default, images are compressed before base-64 encoding for the variables. This can be explicitly set as well:

var createImageVariables = require('images-to-less-variables');

createImageVariables( '*.png', { optimize: false } );

Note: Currently, the images must be uniquely named. The module currently does not handle duplicate file names spread across directories, but this could be added.