nodeON-helpers
A Collection of helper methods.
Install
Install the module using NPM:
npm install nodeon-helpers --save
Table of Contents
- API
- Generate a random string
- Generate a random number
- Get a url safe string
- Truncate arguments from a function
- Skip arguments from a function
- Will copy an array over an existing one
- Get the current user HOME dir
- Determine if a value is numeric
- Determine if Express Request Accepts JSON
- Zero Padding on a number 2 --> '002'
API
Generate a random string
helpers.generateRandomString(optLength)
- optLength
number=
Define length, default 32.Returns
string
The random string.
Returns a randomized string.
Generate a random number
helpers.generateRandomNumber(optLength)
- optLength
number=
Define length, default 20.Returns
string
The random string of numbers.
Returns a randomized string only with numbers.
Get a url safe string
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 = ; var urlString = helpers; console;// prints: "458202-a-name-with-spaces"
Truncate arguments from a function
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 = ; { console; // prints 1 console; // prints "undefined" console; // prints "undefined"} var fn = helpers; ;
Skip arguments from a function
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 = ; { console; // prints 3} var fn = helpers; ;
Will copy an array over an existing one
helpers.pushCopy(src, dst)
- src
Array
The source array.- dst
Array
The destination array.
Will copy an array over an existing one.
var helpers = ; var src = 456;var dst = 123; helpers; console;// prints: [1, 2, 3, 4, 5, 6]
Get the current user HOME dir.
helpers.getUserHome()
Return
string
The full path to the user's HOME.
Get the user's HOME directory.
Determine if a value is numeric.
helpers.isNumeric(value)
- value
string|number
The value to check.Return
boolean
If the value is numeric.
Determine if Express Request Accepts JSON
helpers.isRequestJson(req)
- req
Object
The Express request object.Return
boolean
If client accepts JSON.
Zero Padding on a number
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;// '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.
- Added the
- v0.1.5, 11 Dec 2014
- Added the
isRequestJson
method.
- Added the
- v0.1.4, 24 Oct 2014
- Added
skipArgs()
method.
- Added
- v0.1.3, 19 Sep 2014
- Added
isNumeric()
method.
- Added
- v0.1.0, 14 Aug 2014
- Big Bang
License
Copyright Thanasis Polychronakis. Licensed under the MIT license.