# nodeon-helpers

> A collection of helper funcs

Latest version **1.0.0** (published 2016-05-04) · 0 weekly downloads

## Install

```sh
npm install nodeon-helpers
pnpm add nodeon-helpers
yarn add nodeon-helpers
bun add nodeon-helpers
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-05-04 |
| First published | 2014-08-14 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+6 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Thanasis Polychronakis |
| Maintainers | thanpolas |

## Links

- npm: https://www.npmjs.com/package/nodeon-helpers
- Repository: https://github.com/thanpolas/nodeON-helpers
- Issues: https://github.com/thanpolas/nodeON-helpers/issues
- npm.io page: https://npm.io/package/nodeon-helpers

## Dependencies (3)

- [slug](https://npm.io/package/slug.md) 0.9.1
- [lodash](https://npm.io/package/lodash.md) 3.10.1
- [bluebird](https://npm.io/package/bluebird.md) 2.9.34

## Recent versions

- 1.0.0 (latest) — 2016-05-04
- 0.1.9 — 2015-08-17
- 0.1.8 — 2015-08-14
- 0.1.7 — 2015-05-14
- 0.1.6 — 2015-04-03
- 0.1.5 — 2014-12-11
- 0.1.4 — 2014-10-24
- 0.1.3 — 2014-09-19
- 0.1.2 — 2014-09-19
- 0.1.1 — 2014-09-19
- 0.1.0 — 2014-08-14
- 0.0.1 — 2014-08-14

## README

# nodeON-helpers

> A Collection of helper methods.

[![Build Status](https://secure.travis-ci.org/thanpolas/nodeOn-helpers.png?branch=master)](http://travis-ci.org/thanpolas/nodeOn-helpers)

## Install

Install the module using NPM:

```
npm install nodeon-helpers --save
```

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

1. [API](#api)
    1. [Generate a random string](#generateRandomString)
    1. [Generate a random number](#generateRandomNumber)
    1. [Get a url safe string](#urlify)
    1. [Truncate arguments from a function](#truncateArgs)
    1. [Skip arguments from a function](#skipArgs)
    1. [Will copy an array over an existing one](#pushCopy)
    1. [Get the current user HOME dir](#getUserHome)
    1. [Determine if a value is numeric](#isNumeric)
    1. [Determine if Express Request Accepts JSON](#isRequestJson)
    1. [Zero Padding on a number 2 --> '002'](#zeroPadding)

## 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.

**[[⬆]](#TOC)**


### <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.

**[[⬆]](#TOC)**

### <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.

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

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

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

**[[⬆]](#TOC)**

### <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.

```js
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);
```

**[[⬆]](#TOC)**

### <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.

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

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

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

fn(1, 2, 3);
```

**[[⬆]](#TOC)**




### <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.

```js
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]
```

**[[⬆]](#TOC)**

### <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.

**[[⬆]](#TOC)**

### <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.

**[[⬆]](#TOC)**

### <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.

**[[⬆]](#TOC)**


### <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.

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

**[[⬆]](#TOC)**



## Release History

- **v1.0.0**, *04 May 2016*
    - Remove bcrypt dependency by decoupling all crypto methods into the new package [nodeON-crypto](https://github.com/thanpolas/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](https://github.com/ncb000gt/node.bcrypt.js/issues/325).
    - Upgraded all dependencies to latest.
- **v0.1.7**, *14 May 2015*
    - Made all npm dependencies specific, thank you [@kbariotis](https://github.com/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.

---
_Source: https://npm.io/package/nodeon-helpers · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._