@rgrannell/array v9.4.0

array (v9.3.0)

Stability

0 - Experimental

Various array utilities

Table of Contents

• array.oneOf
  • Parameters
• array.seqTo
  • Parameters
• array.seqAlong
  • Parameters
• array.repeat
  • Parameters
  • Examples

API Documentation

array.oneOf

Select a random value from an input array, using a non-cryptographically secure selector.

Parameters

• value Array<any> An array of arbitrary values

Returns any a randomly selected element from the array

array.seqTo

Create an array of indices up to but not including a ceiling value provided.

Parameters

• number Number a positive number

Returns Array<Number> an array of indices

array.seqAlong

Return an array of indices for an input array

Parameters

• array Array<Any> an arbitrary array

Returns Array<Number> return an array of indices for that array

array.repeat

Repeat an arbitrary value several times

Parameters

• value Any an arbitrary value to repeat
• count Number a nonnegative number describing the number of times to repeat the arbitrary value provided

Examples

array.repeat('a',3)

Returns Array<Any> an array of repeated values.

Dependencies

• Node.js >= v10.6.0
• NPM >= v10.6.0

License

Copyright (c) 2020 Róisín Grannell

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.