@kernel-js/support
Version:
Support package for Kernel Framework
246 lines (164 loc) • 4.9 kB
Markdown
[](https://travis-ci.org/kernel-js/support)
[](https://coveralls.io/github/kernel-js/support?branch=master)
<br />
> Util functions and classes
* Expose some [Lodash](https://www.npmjs.com/package/lodash) functions
* Exports additional helpers
The main inspiration on my work is PHP Laravel Framework which I love because of its simplicity and beauty of code.
First of all I created this to support development of [Kernel Framework](https://www.npmjs.com/package/@kernel-js/framework).<br />
Just like the rest of the packages that make up the framework, I make the most of other existing libraries that are well
tested on a day-to-day basis. The idea is not to reinvent the wheel, just join the ideas in a lightweight framework
(the focus is on the client side), simple to use and make the code on the front more beautiful and organized.
## Install
```npm install @kernel-js/support```
## Helpers
### Custom
* [env](#env)
* [isArray](#isArray)
* [isObject](#isObject)
* [isEmpty](#isEmpty)
* [isNotEmpty](#isNotEmpty)
* [toBoolean](#toBoolean)
* [removeEmpty](#removeEmpty)
* [mapEmptyToNull](#mapEmptyToNull)
## Lodash
* camelCase
* capitalize
* find
* floor
* get
* has
* hasIn
* head
* keysIn
* last
* set
* snakeCase
* startCase
* map
* mapValues
* omitBy
* unset
<br />
<a name="env" /></a>
Gets the value of an environment variable.
env(key, [defaultValue])
__Arguments__
* `key` - the path to the property you want. You can use dot notation on nested objects
* `defaultValue` - the optional default value when the key was not found
```js
// Examples
env('NODE_ENV');
env('app.name');
env('app.name', 'My Default App Name');
```
---------------------------------------
<a name="isArray" /></a>
Return a boolean if the informed value is of Array type.
isArray(value)
__Arguments__
* `value` - any value
```js
// Example
isArray([]); // True
isArray({}); // False
isArray(''); // False
```
---------------------------------------
<a name="isObject" /></a>
Return a boolean if the informed value is of Object type.
isObject(value)
__Arguments__
* `value` - any value
```js
// Example
isObject({}); // True
isObject([]); // False
isObject(''); // False
```
---------------------------------------
<a name="isEmpty" /></a>
Check if the informed value is empty. This is a little different of lodash behaviour,
booleans are not considered empty and ' ' for example is considered empty.
isEmpty(value)
__Arguments__
* `value` - any value
```js
// Examples
isEmpty(true); // false
isEmpty(null); // true
isEmpty(undefined); // true
isEmpty(' '); // true
isEmpty({}); // true
isEmpty([]); // true
```
---------------------------------------
<a name="isNotEmpty" /></a>
Just the oposite of isEmpty.
isNotEmpty(value)
__Arguments__
* `value` - any value
```js
// Examples
isNotEmpty(true); // true
isNotEmpty(null); // false
isNotEmpty(undefined); // false
isNotEmpty(' '); // false
isNotEmpty({}); // false
isNotEmpty([]); // false
```
---------------------------------------
<a name="toBoolean" /></a>
Converts a give string or number into boolean or return null when cannot convert it.
toBoolean(value)
__Arguments__
* `value` - any value
```js
// Examples
toBoolean(1); // true
toBoolean('true'); // true
toBoolean('yes'); // true
toBoolean('on'); // true
toBoolean(0); // false
toBoolean('false'); // false
toBoolean('no'); // false
toBoolean('off'); // false
toBoolean('lorem ipsum'); // null
```
---------------------------------------
<a name="removeEmpty" /></a>
Removes any empty property from object using isEmpty helper.
removeEmpty(value)
__Arguments__
* `value` - any object
```js
// Example
removeEmpty({"a": " ", "b": "b value", "c": null}); // {"b": "b value"}
```
---------------------------------------
<a name="mapEmptyToNull" /></a>
Converts any empty property of object to null using isEmpty helper.
mapEmptyToNull(value)
__Arguments__
* `value` - any object
```js
// Example
mapEmptyToNull({"a": " ", "b": "b value", "c": null, "d": {}}); // {"a": null, "b": "b value", "c": null, "d": null}
```
This library was developed by Gustavo Siqueira, Bruno Santos e Carlos Escouto
Please do! Check out our [Contributing guidelines](CONTRIBUTING.md).
[](LICENSE) © 2018-2018 Brid-IT