extra-generator

Install

1npm install --save extra-generator
2# or
3yarn add extra-generator

API

handleYieldedValues

1function handleYieldedValues<T, Return, Next>(
2  generator: Generator<T, Return, Next>
3, fn: (value: T, index: number) => Next
4): Return

handleYieldedValuesAsync

1function handleYieldedValuesAsync<T, Return, Next>(
2  generator: Generator<T, Return, Next>
3, fn: (value: T, index: number) => PromiseLike<Next>
4): Promise<Return>
5function handleYieldedValuesAsync<T, Return, Next>(
6  generator: AsyncGenerator<T, Return, Next>
7, fn: (value: T, index: number) => Awaitable<Next>
8): Promise<Return>

of

1function of<T>(val: T): IterableIterator<T>

1of(1) // [1]

repeat

1function repeat<T>(val: T, times: number = Infinity): IterableIterator<T>

1repeat(1) // [1, 1, 1, ...]
2repeat(1, 3) // [1, 1, 1]
3repeat(1, 0) // []

spawn

1function spawn<T>(create: (num: number) => T, times: number = Infinity): IterableIterator<T>

1spawn(x => x * 2) // [2, 4, 6, ...]
2spawn(x => x * 2, 3) // [2, 4, 6]
3spawn(x => x * 2, 0) // []

countdown

1function countdown(begin: number, end: number): IterableIterator<number>

1countdown(2, -2) // [2, 1, 0, -1, -2]
2countdown(1, 1) // [1]
3countdown(0, 1) // []

countup

1function countup(begin: number, end: number): IterableIterator<number>

1countup(-2, 2) // [-2, -1, 0, 1, 2]
2countup(1, 1) // [1]
3countup(1, 0) // []

range

1function range(
2  start: number
3, end: number
4, step: number = 1 // step > 0
5, inclusive: boolean = false
6): IterableIterator<number>

1range(1, 1) // []
2range(-2, 2) // [-2, -1, 0, 1]
3range(2, -2) // [2, 1, 0, -1]
4range(1, -1, 0.5) // [1, 0.5, 0, -0.5]
5range(2, -2, 0) // throw Error
6range(2, -2, -0.5) // throw Error

stringifyJSONStream

1function stringifyJSONStream<T>(iterable: Iterable<T>): Iterable<string>

stringifyJSONStreamAsync

1function stringifyNDJSONStreamAsync<T>(iterable: AsyncIterable<T>): AsyncIterable<string>

stringifyNDJSONStream

1function stringifyNDJSONStream<T>(iterable: Iterable<T>): Iterable<string>

stringifyNDJSONStreamAsync

1function stringifyNDJSONStreamAsync<T>(iterable: AsyncIterable<T>): AsyncIterable<string>

timestampBasedId

1function timestampBasedId(): Iterator<[timestamp: number, num: number]>

ReusableIterable

1interface IReusableIterable<T> extends Iterable<T> {
2  close(): void
3}
4
5class ReusableIterable<T> implements IReusableIterable<T> {
6  get done(): boolean | undefined
7
8  constructor(iterable: Iterable<T>)
9
10  close(): void
11}

ReusableAsyncIterable

1interface IReusableAsyncIterable<T> extends AsyncIterable<T> {
2  close(): Promise<void>
3}
4
5class ReusableAsyncIterable<T> implements IReusableAsyncIterable<T> {
6  get done(): boolean | undefined
7
8  constructor(iterable: AsyncIterable<T>)
9
10  close(): Promise<void>
11}

ngrams

1function ngrams(text: string, n: number): IterableIterator<string>

allNgrams

1function allNgrams(text: string): IterableIterator<string>

allCombinations

1function allCombinations<T>(arr: T[], k: number): IterableIterator<T[]>

allIndexCombinations

1function allIndexCombinations(
2  arr: unknown[]
3, k: number
4): IterableIterator<number[]>

positiveFactors

1function positiveFactors(value: number): IterableIterator<number>

1positiveFactors(0) // []
2positiveFactors(10) // [10, 5, 2, 1]
3positiveFactors(-10) // [10, 5, 2, 1]

positiveCommonDivisors

1function positiveCommonDivisors(a: number, b: number): IterableIterator<number>

1positiveCommonDivisors(0, 0) // []
2positiveCommonDivisors(12, 8) // [4, 2, 1]
3positiveCommonDivisors(-12, 8) // [4, 2, 1]

reverse

1function reverse<T>(arr: ArrayLike<T>): IterableIterator<T>