optify v0.0.4

optify 0.0.1

Generates a combination matrix from a set of options key/value pairs.

Motivations

This can be pretty useful for testing all the possible combination of an option parameter. There are probably other usages. Tell me :)

API

optify(options)

var matrix = optify({
	firstName: 'Nicolas',
	lastName: 'Gryman',
	birthDate: '1984-01-17'
});

// produces a the following matrix:
matrix = [
	{ firstName: 1,         lastName: 1,         birthDate: 1         },
	{ firstName: undefined, lastName: 1,         birthDate: 1         },
	{ firstName: 1,         lastName: undefined, birthDate: 1         },
	{ firstName: undefined, lastName: undefined, birthDate: 1         },
	{ firstName: 1,         lastName: 1,         birthDate: undefined },
	{ firstName: undefined, lastName: 1,         birthDate: undefined },
	{ firstName: 1,         lastName: undefined, birthDate: undefined },
	{ firstName: undefined, lastName: undefined, birthDate: undefined }
];

optify(options, undefValue)

var matrix = optify({
	firstName: 'Nicolas',
	lastName: 'Gryman',
	birthDate: '1984-01-17'
}, 'wombat');

// produces a the following matrix:
matrix = [
	{ firstName: 1,        lastName: 1,        birthDate: 1        },
	{ firstName: 'wombat', lastName: 1,        birthDate: 1        },
	{ firstName: 1,        lastName: 'wombat', birthDate: 1        },
	{ firstName: 'wombat', lastName: 'wombat', birthDate: 1        },
	{ firstName: 1,        lastName: 1,        birthDate: 'wombat' },
	{ firstName: 'wombat', lastName: 1,        birthDate: 'wombat' },
	{ firstName: 1,        lastName: 'wombat', birthDate: 'wombat' },
	{ firstName: 'wombat', lastName: 'wombat', birthDate: 'wombat' }
];

optify(options, callback)

optify({
	firstName: 'Nicolas',
	lastName: 'Gryman',
	birthDate: '1984-01-17'
}, function(opt, i) {
	console.log('[' + i + '] ' + opt);
});

// outputs:
// [0] { 'firstName': 'Nicolas', 'lastName': 'Gryman', 'birthDate': '1984-01-17' }
// [1] { 'firstName': undefined, 'lastName': 'Gryman', 'birthDate': '1984-01-17' }
// [2] { 'firstName': 'Nicolas', 'lastName': undefined, 'birthDate': '1984-01-17' }
// [3] { 'firstName': undefined, 'lastName': undefined, 'birthDate': '1984-01-17' }
// [4] { 'firstName': 'Nicolas', 'lastName': 'Gryman', 'birthDate': undefined }
// [5] { 'firstName': undefined, 'lastName': 'Gryman', 'birthDate': undefined }
// [6] { 'firstName': 'Nicolas', 'lastName': undefined, 'birthDate': undefined }
// [7] { 'firstName': undefined, 'lastName': undefined, 'birthDate': undefined }

optify(options, callback, undefValue)

optify({
	firstName: 'Nicolas',
	lastName: 'Gryman',
	birthDate: '1984-01-17'
}, function(opt, i) {
	console.log('[' + i + '] ' + opt);
});

// outputs:
// [0] { 'firstName': 'Nicolas', 'lastName': 'Gryman', 'birthDate': '1984-01-17' }
// [1] { 'firstName': 'wombat', 'lastName': 'Gryman', 'birthDate': '1984-01-17' }
// [2] { 'firstName': 'Nicolas', 'lastName': 'wombat', 'birthDate': '1984-01-17' }
// [3] { 'firstName': 'wombat', 'lastName': 'wombat', 'birthDate': '1984-01-17' }
// [4] { 'firstName': 'Nicolas', 'lastName': 'Gryman', 'birthDate': 'wombat' }
// [5] { 'firstName': 'wombat', 'lastName': 'Gryman', 'birthDate': 'wombat' }
// [6] { 'firstName': 'Nicolas', 'lastName': 'wombat', 'birthDate': 'wombat' }
// [7] { 'firstName': 'wombat', 'lastName': 'wombat', 'birthDate': 'wombat' }