# array-pad

> Module for returning arrays with a specific length by padding values.

Latest version **0.0.1** (published 2015-01-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install array-pad
pnpm add array-pad
yarn add array-pad
bun add array-pad
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2015-01-27 |
| First published | 2015-01-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Christopher Turner |
| Maintainers | tur-nr |
| Keywords | array, pad, utility, length |

## Links

- npm: https://www.npmjs.com/package/array-pad
- Repository: https://github.com/tur-nr/node-array-pad
- Issues: https://github.com/tur-nr/node-array-pad/issues
- npm.io page: https://npm.io/package/array-pad

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2015-01-27

## README

# array-pad

Module for returning arrays with a specific length by padding values.

[![Build Status](https://travis-ci.org/tur-nr/node-array-pad.svg?branch=master)](https://travis-ci.org/tur-nr/node-array-pad)

### Example

```js
var pad = require('array-pad');
var arr = pad([], 3, null); // => [null, null, null] 
arr = pad(arr, 5, 0);       // => [null, null, null, 0, 0];
```

## Installation

### Node

To install `array-pad` in a Node application use npm.

```
$ npm install array-pad
```

### Browser

No tests available for the browser but you may try using it via [webpack](https://github.com/webpack/webpack).

```
$ webpack index.js array-pad.js
```

## Test

To run tests use npm.

```
$ npm install
$ npm test
```

## Documentation

### Basic Usage

Padding an `array` is simple as passing the desired `length` and an optional `value` to pad with. If no `value` is given, padded items will be set to `undefined` by default.

```js
var array = pad([], 2); // => [undefined, undefined]
pad(array, 4, null);    // => [undefined, undefined, null, null]
pad(array, 1, false);   // => [undefined, undefined, null, null]
```

### Pad Left

Pad, by default, pads `value`s to the right side of the `array` via the `.push()` method. To pad left, perform `.unshift()`, pass then `length` as a negative integer.

```js
pad([1,2,3], -5, 0); // => [0, 0, 1, 2, 3]
```

### Augmenting Array

Pad will always create a new instance of the `array` passed in. If augmentation to the original instance is required, pass the first parameter as `true`.

```js
var arr = [];
var res = pad(true, arr, 3);
res === arr; // => true
```

## API

#### pad(*[augment]*, *<array>*, *<length>*, *[value]*);

## License

[MIT](LICENSE)

Copyright (c) 2015 [Christopher Turner](https://github.com/tur-nr)

---
_Source: https://npm.io/package/array-pad · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._