sak v0.1.5

Swiss Army Knife (SAK)

Version 0.1.5

Swiss Army Knife for Node.js. Use this module for developing you application. Once you're done grap the individual modules for production.

Created by Thomas de Zeeuw, thomasdezeeuw@gmail.com (https://thomasdezeeuw.nl/).

Released under a MIT license.

Exports

Clone

Function

Clone an object.

Example

var clone = require('sak').clone
  , obj1 = {a: 'a'}
  , obj2 = clone(obj1);

console.log('obj2', obj2); // obj2 {a: 'a'}
console.log(obj1 == obj2); // false

Params

Return

Merge

Function

Merge an object with other object(s).

Example

var merge = require('sak').merge
  , obj1 = {a: 'a'}
  , obj2 = {b: 'b'};

var obj = merge(obj1, obj2);
console.log('obj', obj) // Obj {a: 'a', b: 'b'}

Params

Return

isObject

Function

Test if an variable is an object.

Example

var obj1 = {a: 'a'}
  , obj2 = 'not an object';

var test1 = isObject(obj1)
  , test2 = isObject(obj2);
console.log('test1', test1) // test1 true
console.log('test2', test2) // test2 false

Params

Return

IsFunction

Function

Test if an variable is a function.

Example

var obj1 = function () {}
 , obj2 = 'not a function';

var test1 = isFunction(obj1)
 , test2 = isFunction(obj2);
console.log('test1', test1) // test1 true
console.log('test2', test2) // test2 false

Params

Return

firstToUpper

Function, public.

Capitalize the first letter of a string.

Example

var string = 'my string'
  , upperString = firstToUpper(string);

console.log('upperString', upperString) // upperString My string

Params

Return

forkArguments

encode

Function

Encode arguments to pass when forking a process.

Example

// Master process
var options = {port: 8000, env: 'production'}
  , encoded = encode(options)
  , child = cp.fork('./my-child-script.js', encoded);

Params

Return

decode

Function

Decode arguments that are passed to a forked process.

Example

// Child process
var options = decode(process.argv.slice(2));
console.log('options', options); // options {port: 8000, env: 'production'}

Params

Return