https://github.com/manferlo81/args-to-arr

Converts arguments or any other array-like object into an array starting from specific index.
https://github.com/manferlo81/args-to-arr

arguments array array-like convert params rest slice to-array

Last synced: about 1 year ago
JSON representation

Converts arguments or any other array-like object into an array starting from specific index.

• Host: GitHub
• URL: https://github.com/manferlo81/args-to-arr
• Owner: manferlo81
• License: mit
• Created: 2019-04-18T08:09:48.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2025-03-04T00:09:18.000Z (about 1 year ago)
• Last Synced: 2025-03-06T16:08:08.166Z (about 1 year ago)
• Topics: arguments, array, array-like, convert, params, rest, slice, to-array
• Language: TypeScript
• Homepage:
• Size: 3.5 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# args-to-arr

[![CircleCI](https://circleci.com/gh/manferlo81/args-to-arr.svg?style=svg)](https://circleci.com/gh/manferlo81/args-to-arr)

[![npm](https://badgen.net/npm/v/args-to-arr)](https://www.npmjs.com/package/args-to-arr)

[![codecov](https://codecov.io/gh/manferlo81/args-to-arr/branch/master/graph/badge.svg)](https://codecov.io/gh/manferlo81/args-to-arr)

[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/args-to-arr/badge?style=rounded)](https://www.jsdelivr.com/package/npm/args-to-arr)

[![packagephobia](https://badgen.net/packagephobia/install/args-to-arr)](https://packagephobia.now.sh/result?p=args-to-arr)

[![bundlephobia](https://badgen.net/bundlephobia/min/args-to-arr)](https://bundlephobia.com/result?p=args-to-arr)

[![types](https://img.shields.io/npm/types/args-to-arr.svg)](https://github.com/microsoft/typescript)

[![Known Vulnerabilities](https://snyk.io/test/github/manferlo81/args-to-arr/badge.svg?targetFile=package.json)](https://snyk.io/test/github/manferlo81/args-to-arr?targetFile=package.json)

[![license](https://badgen.net/github/license/manferlo81/args-to-arr)](LICENSE)

Converts `arguments` or any other `array-like` object into an `array` starting from specific index.

*Inspired by how Typescript handles `...rest` arguments.*

## Install

```bash

npm i args-to-arr

```

## CDN

### jsDelivr

```html

```

***for production***

```html

```

*[more options...](https://www.jsdelivr.com/package/npm/args-to-arr?version=latest)*

### unpkg

```html

```

***for production***

```html

```

*[more options...](https://unpkg.com/args-to-arr@latest/)*

## Usage

### Node.js

```javascript

const toArray = require("args-to-arr");

const array = toArray(arrayLike, start);

```

### Browser

*After adding the* `script` *tag,* `toArray` *function will be available globally.*

```javascript

const array = toArray(arrayLike, start);

```

## Reference

***example***

```javascript

import toArray from "args-to-arr";

function anything(firstArg) {

  // convert arguments to array

  // starting from argument 1

  // it won't include firstArg

  const args = toArray(arguments, 1);

  // do something with the array

}

```

***syntax***

```typescript

toArray(arr: ArrayLike, start: number = 0): T[];

```

### return

*type*: `Array`

*It returns a new array based on the provided parameters.*

### arr

*type*: `Array` | `ArrayLike`

*Array or Array-like object to be converted to a new array.*

### start

*type*: `number`

*default*: `0`

*Index number for array convertion to start from. If not provided or it equals* `null` *or* `undefined` *it will default to* `0`*.*

*Providing a negative start index will cause the function to start iterating* `X` *items from the end of the array, see the following example.*

***example***

```javascript

const array = toArray([1, 2, 3, 4], -2);

console.log(array);

```

```console

[ 3, 4 ]

```

*If the provided negative start index exceeds the size of the array, it will fill the begining of the resulting array with* `empty` *values.*

***example***

```javascript

const array = toArray([1, 2], -4);

console.log(array);

```

```console

[ <2 empty items>, 1, 2 ]

```

## License

[MIT](LICENSE) © [Manuel Fernández](https://github.com/manferlo81)