@polkadot/util/cjs/array/range.js

A collection of useful utilities for @polkadot

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.arrayRange = arrayRange;

var _assert = require("../assert");

// Copyright 2017-2022 @polkadot/util authors & contributors
// SPDX-License-Identifier: Apache-2.0

/**
 * @name arrayRange
 * @summary Returns a range of numbers ith the size and the specified offset
 * @description
 * Returns a new array of numbers with the specific size. Optionally, when `startAt`, is provided, it generates the range to start at a specific value.
 * @example
 * <BR>
 *
 * ```javascript
 * import { arrayRange } from '@polkadot/util';
 *
 * arrayRange(5); // [0, 1, 2, 3, 4]
 * arrayRange(3, 5); // [5, 6, 7]
 * ```
 */
function arrayRange(size) {
  let startAt = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
  (0, _assert.assert)(size > 0, 'Expected non-zero, positive number as a range size');
  const result = new Array(size);

  for (let i = 0; i < size; i++) {
    result[i] = i + startAt;
  }

  return result;
}