@kernel-js/support
Util functions and classes
- Expose some Lodash functions
- Exports additional helpers
Inspirations
The main inspiration on my work is PHP Laravel Framework which I love because of its simplicity and beauty of code.
Why
First of all I created this to support development of Kernel Framework.
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
Lodash
- camelCase
- capitalize
- find
- floor
- get
- has
- hasIn
- head
- keysIn
- last
- set
- snakeCase
- startCase
- map
- mapValues
- omitBy
- unset
env
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 objectsdefaultValue
- the optional default value when the key was not found
env('NODE_ENV');
env('app.name');
env('app.name', 'My Default App Name');
isArray
Return a boolean if the informed value is of Array type.
isArray(value)
Arguments
isArray([]);
isArray({});
isArray('');
isObject
Return a boolean if the informed value is of Object type.
isObject(value)
Arguments
isObject({});
isObject([]);
isObject('');
isEmpty
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
isEmpty(true);
isEmpty(null);
isEmpty(undefined);
isEmpty(' ');
isEmpty({});
isEmpty([]);
isNotEmpty
Just the oposite of isEmpty.
isNotEmpty(value)
Arguments
isNotEmpty(true);
isNotEmpty(null);
isNotEmpty(undefined);
isNotEmpty(' ');
isNotEmpty({});
isNotEmpty([]);
toBoolean
Converts a give string or number into boolean or return null when cannot convert it.
toBoolean(value)
Arguments
toBoolean(1);
toBoolean('true');
toBoolean('yes');
toBoolean('on');
toBoolean(0);
toBoolean('false');
toBoolean('no');
toBoolean('off');
toBoolean('lorem ipsum');
removeEmpty
Removes any empty property from object using isEmpty helper.
removeEmpty(value)
Arguments
removeEmpty({"a": " ", "b": "b value", "c": null});
mapEmptyToNull
Converts any empty property of object to null using isEmpty helper.
mapEmptyToNull(value)
Arguments
mapEmptyToNull({"a": " ", "b": "b value", "c": null, "d": {}});
Authors
This library was developed by Gustavo Siqueira, Bruno Santos e Carlos Escouto
Contribute
Please do! Check out our Contributing guidelines.
License
MIT © 2018-2018 Brid-IT