empty

Utility that provides different types of empty objects.

empty

Utility that provides different types of empty objects. All objects returned by this library are immutable (made so using Object.freeze) unless the NODE_ENV environment variable is set to 'production'.

Installation

The library is written for CommonJS environments such as Node and works beautifully in the browser using something like Browserify.

To install, make sure you have Node installed, then, in your project directory, run:

$ npm install empty

API

var empty = require('empty');
var emptyObject = empty.object;
 
// or 
 
var emptyObject = require('empty/object');
 
console.log(emptyObject);
// {} 
var emptyArray = empty.array;
 
// or 
 
var emptyArray = require('empty/array');
 
console.log(emptyArray);
// [] 
var emptyFunction = empty.func;
 
// or 
 
var emptyFunction = require('empty/function');
 
console.log(emptyFunction);
// function () {} 
var functionThatReturns = empty.functionThatReturns;
 
// or 
 
var functionThatReturns = require('empty/functionThatReturns');
 
console.log(functionThatReturns('foo')());
// 'foo' 
var functionThatReturnsTrue = empty.functionThatReturnsTrue;
 
// or 
 
var functionThatReturnsTrue = require('empty/functionThatReturnsTrue');
 
console.log(functionThatReturnsTrue());
// true 
var functionThatReturnsFalse = empty.functionThatReturnsFalse;
 
// or 
 
var functionThatReturnsFalse = require('empty/functionThatReturnsFalse');
 
console.log(functionThatReturnsFalse());
// false 
var functionThatReturnsNull = empty.functionThatReturnsNull;
 
// or 
 
var functionThatReturnsNull = require('empty/functionThatReturnsNull');
 
console.log(functionThatReturnsNull());
// null 
var functionThatReturnsThis = empty.functionThatReturnsThis;
 
// or 
 
var functionThatReturnsThis = require('empty/functionThatReturnsThis');
 
console.log(functionThatReturnsThis.call({a: 1}));
// {a: 1} 
var functionThatReturnsArgument = empty.functionThatReturnsArgument;
 
// or 
 
var functionThatReturnsArgument = require('empty/functionThatReturnsArgument');
 
console.log(functionThatReturnsArgument('foo'));
// 'foo' 

Credits

Many thanks to Arturo for the name on NPM. The original package repository can be found at here.