@nuskin/npm-library-template
v1.0.0
Published
uncle-buck` is a compilation of useful functions.
Downloads
9
Keywords
Readme
@nuskin/uncle-buck
uncle-buck
is a compilation of useful functions.
Installing
Using npm:
npm install @nuskin/uncle-buck
Using yarn:
yarn add @nuskin/uncle-buck
Example Usage
const ub = require('@nuskin/uncle-buck')
ub.isJSON('{"abc":true}') // returns true
ub.isNull(null) // returns true
ub.isObject('{"abc":true}') // returns false
ub.isString('my string') // returns true
ub.nvl(null,0) // returns 0
Functions
isJSON(str) ⇒ Boolean
isJSON tests if str
is valid JSON.
Kind: global function
Returns: Boolean - Returns true if string is valid JSON
| Param | Type | Description | | --- | --- | --- | | str | String | String to test |
isNull(n) ⇒ Boolean
isNull tests if n
is null
or undefined
.
Kind: global function
Returns: Boolean - Returns true if the value is null
or undefined
| Param | Type | Description | | --- | --- | --- | | n | * | value to test |
isObject(variable) ⇒ Boolean
isObject tests if variable
is an object
Kind: global function
Returns: Boolean - Returns true if variable
is an object
| Param | Type | Description | | --- | --- | --- | | variable | * | value to test |
isString(variable) ⇒ Boolean
isString tests if variable
is a String
Kind: global function
Returns: Boolean - Returns true if variable
is a String
| Param | Type | Description | | --- | --- | --- | | variable | * | value to test |
nvl(n, (*)) ⇒ *
nvl lets you replace null or undefined with a value of your choice. If n
is null or undefined,
then nvl returns val
. If n
is not null or undefined, then nvl returns n
.
Kind: global function
Returns: * - Returns val
when n
is null or undefined
| Param | Type | Description |
| --- | --- | --- |
| n | * | The value you want to test for null or undefined |
| (*) | | val - The value you want returned when n
is null or undefined |
Resources
- Changelog could go here