npm package: @rgrannell/generator
Description: An itertools like library
Latest version: 9.4.0


# generator (v9.3.0)

## Stability

> 0 - Experimental

An itertools like library



## Table of Contents

- [generator.cycle](#generatorcycle)
  * [Parameters](#parameters)
- [generator.repeat](#generatorrepeat)
  * [Parameters](#parameters-1)
- [generator.iterMap](#generatoritermap)
  * [Parameters](#parameters-2)
- [generator.iterSelect](#generatoriterselect)
  * [Parameters](#parameters-3)
- [generator.crossProduct](#generatorcrossproduct)
  * [Parameters](#parameters-4)
- [generator.increment](#generatorincrement)
  * [Parameters](#parameters-5)
- [generator.charRange](#generatorcharrange)
  * [Parameters](#parameters-6)

## API Documentation

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

## generator.cycle

Infinitly cycle a generator

### Parameters

-   `gen` **Generator** a generator function

## generator.repeat

Repeat a generator a fixed number of times

### Parameters

-   `gen` **Generator** a generator function

## generator.iterMap

Map across an iterable

### Parameters

-   `fn` **[Function][1]** an arbitrary non-generator function
-   `iter` **Any** the iterator to transform

## generator.iterSelect

Filter an iterable

### Parameters

-   `pred` **[Function][1]** a boolean function
-   `iter` **Any** the iterator to filter

## generator.crossProduct

Take the cross-product of several generators

### Parameters

-   `gens` **[Array][2]&lt;Gen>** an array of nullary generator functions

## generator.increment

Yield an incrementing sequence of numbers

### Parameters

-   `num` **[number][3]** an (exclusive) upper limiting number

## generator.charRange

Yield a list of characters in an inclusive range

### Parameters

-   `lower` **[Number][3]** The lower char-code used
-   `upper` **[Number][3]** The upper char-code used

[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function

[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array

[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number


## 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.