# `piupiu.`

[![CI](https://github.com/thomasbrodusch/piupiu/actions/workflows/ci.yaml/badge.svg?branch=develop)](/https://github.com/thomasbrodusch/hive/actions/workflows/ci.yaml)
![license](https://img.shields.io/github/license/thomasbrodusch/piupiu?color=%2365C764)

JavaScript utilities functions that got your back.

Using **Yarn** :
```bash
yarn add piupiu -D
```
Using **NPM** :
```bash
npm -i piupiu 
```

## Initialize

Just import it like any other lib.

```javascript
import piupiu from 'piupiu'
```

## Usage

- Getting started
    - [Quick start](./docs/quickstart.md)

- Mocking
  - [ MockFactory ](./docs/mocking/mock.factory.md)

- Randomizers
  - [ randomString ](./docs/randomizers/randomString.md)
  - [ randomNumber ](./docs/randomizers/randomNumber.md)
  - [ randomBoolean ](./docs/randomizers/randomBoolean.md)
  - [ randomObject ](./docs/randomizers/randomObject.md)
  - [ randomItemInArray ](./docs/randomizers/randomItemInArray.md)

- Sanitizers
    - [ cleanAccent ](./docs/sanitizers/cleanAccents.md)
    - [ cleanPunctuation ](./docs/sanitizers/cleanPunctuation.md)
    - [ cleanSpaces ](./docs/sanitizers/cleanSpaces.md)

- Transformers
    - [ camelCase ](./docs/transformers/camelCase.md)
    - [ capitalize ](./docs/transformers/capitalize.md)
    - [ snakeCase ](./docs/transformers/snakeCase.md)
    - [ formatJapaneseUnicode ](./docs/transformers/formatJapaneseUnicode.md)
    - [ stringSegmenter ](./docs/transformers/stringSegmenter.md)
  
- Validators
  - [ isString ](./docs/validators/isString.md)
  - [ isEmail ](./docs/validators/isEmail.md)
  - [ isCreditCardNumber ](./docs/validators/isCreditCardNumber.md)