> Checkout [related packages](#related-packages)
Install via npm:
```shell
$ npm install -g @bavary/lib
```
Install via yarn:
```shell
$ yarn global add @bavary/lib
```
Include directly via jsdelivr:
```html
```
## Usage
```js
import {
/**
* Custom functions crafted for @bavary/core.
* Checkout the available-functions section for more info!
*/
functions,
/**
* Pass an array of function-names you want to use.
* Returns an object with functions.
*/
use
} from '@bavary/lib';
```
If you want to use these but have no idea how: checkout the [documentation](https://github.com/Simonwep/bavary/blob/master/docs/config.md#custom-functions) for how function work. You can even make custom ones!
#### Functions
> Checkout the source if you want to now exactly whats going on in each function!
* [ignore(...values)](src/functions/ignore.ts) _- Does nothing. Can be used to ignore the value of nested groups._
* [count(value, tag)](src/functions/count.ts) _- Saves the length of `value` (either array or string) into `tag`._
* [pick(value, property)](src/functions/pick.ts) _- Extracts `property` from `value` and applies it as current result._
* [concat(a, b, tag?)](src/functions/concat.ts) _- Concatenates strings, arrays or objects.
* [expectEqual(msg | 'null', ...values)](src/functions/expect-equal.ts) _- Check whenever all values are equal. Returns false if first argument is `null`, otherwise the string is thrown as error. Returns `false` if at least one value is `null`._
* [defineProperty(tag, ...values)](src/functions/define-property.ts) _- Saves whatever is passed after the tag as property into the result. If more than one value is passed into it they're wrapped into an array._
* [deleteProperty(...props)](src/functions/delete-property.ts) _- Deletes properties by their name in the current result._
If no tag is specified for objects and arrays the value will be appended to `a` (Via `.push` or `Object.assign`). The `tag` is mandatory for strings._
#### Related packages
* [@bavary/core](https://github.com/Simonwep/bavary) _- Parser and compiler._
* [@bavary/cli](https://github.com/Simonwep/bavary-cli) _- CLI with development server._
* [@bavary/lib](https://github.com/Simonwep/bavary-lib) _- Standard library with extensions for bavary._