orxapi.tools.array/README.md

The TypeScript array tools library for orxapi

[![npm version](https://badge.fury.io/js/orxapi.tools.array.svg)](https://badge.fury.io/js/orxapi.tools.array.svg)

# orxapi.tools.array
The Array tools library for orxapi. 

## Getting Started

If you haven't used [NodeJs](http://nodejs.org/) before, be sure to have install the LTS version on your desktop ! Check your version with this command:

```shell
node -v
v8.0.0
```

## Installation

```shell
npm install orxapi.tools.toscroll --save-dev
```

This library is written in TypeScript, but you can use JavaScript.

## Usage
TypeScript code
```ts
import { makeArray, range } from "orxapi.tools.array";

// Create array calendar with 42 days (7 days x 6 weeks)
const days = makeArray(42);

// Create option list with range
const optionList = seq("2..8").map((value: number) => ({ code: `${value}`, val: `${value}` }));
```

## Methods
- **makeArray** Make a fill array with number <br>
- **~~range~~** Deprecated use seq method <br>
- **seq** Make a fill array with number between min and max value <br>
- **pad** Format a Number, Exactly Two in Length <br>
- **chuck** Split an array on multiple array <br>


See docs for more information

*This library was designed to work with ES 5+*

### TODO

- [ ] Add tests
- [ ] Improve the documentation