JSPM

  • Created
  • Published
  • Downloads 248
  • Score
    100M100P100Q76923F
  • License MIT

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

Package Exports

  • args-to-arr

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (args-to-arr) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

args-to-arr

CircleCI dependabot npm codecov jsDelivr dependencies dev dependencies packagephobia bundlephobia types Known Vulnerabilities license

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

Inspired by how Typescript handles ...rest arguments.

Install

npm i args-to-arr

CDN

jsDelivr

<script src="https://cdn.jsdelivr.net/npm/args-to-arr@latest/dist/args-to-arr.umd.js"></script>

for production

<script src="https://cdn.jsdelivr.net/npm/args-to-arr@latest/dist/args-to-arr.umd.min.js"></script>

more options...

unpkg

<script src="https://unpkg.com/args-to-arr@latest/dist/args-to-arr.umd.js"></script>

for production

<script src="https://unpkg.com/args-to-arr@latest/dist/args-to-arr.umd.min.js"></script>

more options...

Usage

Node.js

const toArray = require("args-to-arr");
const array = toArray(arrayLike, start);

Browser

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

const array = toArray(arrayLike, start);

Reference

example

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

toArray<T>(arr: ArrayLike<T>, 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

const array = toArray([1, 2, 3, 4], -2);
console.log(array);
[ 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

const array = toArray([1, 2], -4);
console.log(array);
[ <2 empty items>, 1, 2 ]

License

MIT © Manuel Fernández