Awesome

nodeON-helpers

A Collection of helper methods.

Install

Install the module using NPM:

npm install nodeon-helpers --save

<a name='TOC'>Table of Contents</a>

1. API
   1. Generate a random string
   2. Generate a random number
   3. Get a url safe string
   4. Truncate arguments from a function
   5. Skip arguments from a function
   6. Will copy an array over an existing one
   7. Get the current user HOME dir
   8. Determine if a value is numeric
   9. Determine if Express Request Accepts JSON
   10. Zero Padding on a number 2 --> '002'

API

<a name='generateRandomString'>Generate a random string</a>

helpers.generateRandomString(optLength)

• optLength number= Define length, default 32.

Returns string The random string.

Returns a randomized string.

[⬆]

<a name='generateRandomNumber'>Generate a random number</a>

helpers.generateRandomNumber(optLength)

• optLength number= Define length, default 20.

Returns string The random string of numbers.

Returns a randomized string only with numbers.

[⬆]

<a name='urlify'>Get a url safe string</a>

helpers.urlify(text, optRandLen)

• text string The string to urlify.
• optRandLen number How many numbers to use for randomizing the url, default 6.

Get a url safe string.

var helpers = require('nodeon-helpers');

var urlString = helpers.urlify('a name with spaces');

console.log(urlString);
// prints: "458202-a-name-with-spaces"

[⬆]

<a name='truncateArgs'>Truncate arguments from a function</a>

helpers.truncateArgs(fn, count, optSelf)

• fn Function The function to truncate arguments.
• count number How many arguments to allow before truncating.
• optSelf Object= Optionally apply context.

Return Function The function to invoke.

Will truncate arguments from a function.

var helpers = require('nodeon-helpers');

function run(one, two, three) {
    console.log(one); // prints 1
    console.log(two); // prints "undefined"
    console.log(three); // prints "undefined"
}

var fn = helpers.truncateArgs(run, 1);

fn(1, 2, 3);

[⬆]

<a name='skipArgs'>Skip arguments from a function</a>

helpers.skipArgs(fn, count, optSelf)

• fn Function The function to skip arguments for.
• count number How many arguments to skip.
• optSelf Object= Optionally apply context.

Return Function The function to invoke.

Will skip the first n arguments from a function.

var helpers = require('nodeon-helpers');

function run(one) {
    console.log(one); // prints 3
}

var fn = helpers.skipArgs(run, 2);

fn(1, 2, 3);

[⬆]

<a name='pushCopy'>Will copy an array over an existing one</a>

helpers.pushCopy(src, dst)

• src Array The source array.
• dst Array The destination array.

Will copy an array over an existing one.

var helpers = require('nodeon-helpers');

var src = [4,5,6];
var dst = [1,2,3];

helpers.pushCopy(src, dst);

console.log(dst);
// prints: [1, 2, 3, 4, 5, 6]

[⬆]

<a name='getUserHome'>Get the current user HOME dir.</a>

helpers.getUserHome()

Return string The full path to the user's HOME.

Get the user's HOME directory.

[⬆]

<a name='isNumeric'>Determine if a value is numeric.</a>

helpers.isNumeric(value)

• value string|number The value to check.

Return boolean If the value is numeric.

[⬆]

<a name='isRequestJson'>Determine if Express Request Accepts JSON</a>

helpers.isRequestJson(req)

• req Object The Express request object.

Return boolean If client accepts JSON.

[⬆]

<a name='zeroPadding'>Zero Padding on a number</a>

helpers.zeroPadding(number, width)

• number number The number to apply zeropadding on.
• number width The padding.

Return string The zero padded number.

var padded = helpers.zeroPadding(2, 3);
// '002'

[⬆]

Release History

• v1.0.0, 04 May 2016
  • Remove bcrypt dependency by decoupling all crypto methods into the new package nodeON-crypto.
  • Removed methods:
    • salt
    • setSalt
    • hash
    • hashVerify
• v0.1.9, 17 Aug 2015
  • Added option to ignore char limit for hash.
• v0.1.8, 14 Aug 2015
  • Will now return error if string for hash is 72chars or longer, bcrypt will not handle it.
  • Upgraded all dependencies to latest.
• v0.1.7, 14 May 2015
  • Made all npm dependencies specific, thank you @kbariotis.
• v0.1.6, 03 Apr 2015
  • Added the zeroPadding method.
• v0.1.5, 11 Dec 2014
  • Added the isRequestJson method.
• v0.1.4, 24 Oct 2014
  • Added skipArgs() method.
• v0.1.3, 19 Sep 2014
  • Added isNumeric() method.
• v0.1.0, 14 Aug 2014
  • Big Bang

License

Copyright Thanasis Polychronakis. Licensed under the MIT license.