iterplus - v3.0.2

Index

Classes

Type aliases

Variables

nullVal

Functions

Type aliases

Null

Null: typeof nullVal

The type of null to use.

PromiseOrValue

PromiseOrValue<T>: T | Promise<T>

A promise or a value that can be awaited.

Type parameters

T

Variables

nullVal

nullVal: null = null

The value of null to use.

Defaults to null.

Functions

asyncIterplus

asyncIterplus<T>(iter: AsyncIterable<T>): AsyncIterPlus<T>

- Defined in util.ts:25
Generates an AsyncIterPlus from an async iterable.

Type parameters
- T
  
  The iteration type.
Parameters
- iter: AsyncIterable<T>
  
  The async iterable to upgrade.
Returns AsyncIterPlus<T>

asyncify

asyncify<A, R>(func: (...args: A) => R): (...args: A) => Promise<R>

- Defined in util.ts:144
Lifts an function to an async function that immediately resolves the return value.

Type parameters
- A: unknown[]
  
  The arguments of the function.
- R
  
  The return value of the function.
Parameters
- func: (...args: A) => R
  
  The function to lift.
  - - (...args: A): R
    - Parameters
      - Rest ...args: A
      Returns R
Returns (...args: A) => Promise<R>
The lifted function.
- - (...args: A): Promise<R>
  - Lifts an function to an async function that immediately resolves the return value.
    
    Parameters
    - Rest ...args: A
    Returns Promise<R>
    The lifted function.

canAsyncIter

canAsyncIter(obj: any): obj is AsyncIterable<unknown>

- Defined in AsyncIterPlus.ts:23
Tests if an object is iterable.

Parameters
- obj: any
  
  The object to test for.
Returns obj is AsyncIterable<unknown>
If obj is an iterable.

canIter

canIter(obj: any): obj is Iterable<unknown>

- Defined in IterPlus.ts:25
Tests if an object is iterable.

Parameters
- obj: any
  
  The object to test for.
Returns obj is Iterable<unknown>
If obj is an iterable.

count

count(start: bigint, step?: bigint): IterPlus<bigint>
count(start: number, step?: number): IterPlus<number>

- Defined in util.ts:95
Creates an iterator that keeps adding values to a starting point.

Parameters
- start: bigint
  
  The starting point.
- Optional step: bigint
  
  The step.
Returns IterPlus<bigint>
- Defined in util.ts:102
Creates an iterator that keeps adding values to a starting point.

Parameters
- start: number
  
  The starting point.
- Optional step: number
  
  The step.
Returns IterPlus<number>

isAsyncIter

isAsyncIter(obj: any): obj is AsyncIterator<unknown, any, undefined>

- Defined in AsyncIterPlus.ts:10
Tests if an object is an iterator.

Parameters
- obj: any
  
  The object to test for.
Returns obj is AsyncIterator<unknown, any, undefined>
If obj is an iterator.

isIter

isIter(obj: any): obj is Iterator<unknown, any, undefined>

- Defined in IterPlus.ts:10
Tests if an object is an iterator.

Parameters
- obj: any
  
  The object to test for.
Returns obj is Iterator<unknown, any, undefined>
If obj is an iterator.

iterplus

iterplus<T>(iter: Iterable<T>): IterPlus<T>

- Defined in util.ts:15
Generates an IterPlus from an iterable.

Type parameters
- T
  
  The iteration type.
Parameters
- iter: Iterable<T>
  
  The iterable to upgrade.
Returns IterPlus<T>

liftAsync

liftAsync<T>(iterable: Iterable<T>): AsyncIterPlus<T>

- Defined in util.ts:127
Lifts an iterable to an async iterable that immediately resolves promises.

Type parameters
- T
  
  The item of the iterator.
Parameters
- iterable: Iterable<T>
  
  The iterable to lift.
Returns AsyncIterPlus<T>
The lifted iterator.

range

range(start: bigint, dest?: bigint, step?: bigint): IterPlus<bigint>
range(start: number, dest?: number, step?: number): IterPlus<number>

- Defined in util.ts:36
Creates an inclusive-exclusive range iterator that's useful for loops.

Parameters
- start: bigint
  
  The starting point.
- Optional dest: bigint
  
  The ending point, exclusive.
- Optional step: bigint
  
  The step, can be negative to go down.
Returns IterPlus<bigint>
- Defined in util.ts:48
Creates an inclusive-exclusive range iterator that's useful for loops.

Parameters
- start: number
  
  The starting point.
- Optional dest: number
  
  The ending point, exclusive.
- Optional step: number
  
  The step, can be negative to go down.
Returns IterPlus<number>

Generated using TypeDoc