Class AsyncIterCore

The core iteration functions.

Since

v1.1.3

Index

Methods

assert is isNot result

Methods

`Static`assert

assert<T>(value: unknown): asserts value is AsyncIterable<T, any, any>
Asserts that the given value is an async iterable.
Type Parameters
- T
  The type of elements contained in the async iterable.
Parameters
- value: unknown
  The value to check.
Returns asserts value is AsyncIterable<T, any, any>
The value as an async iterable.

Throws
If the value is not an async iterable.

Since
v1.1.3
- Defined in src/lib/AsyncIterCore.mts:54

`Static`is

is<T>(value: unknown): value is AsyncIterable<T, any, any>
Type guard that checks if a value is an async iterable object.
Type Parameters
- T
  The type of elements contained in the async iterable.
Parameters
- value: unknown
  The value to check for async iterability.
Returns value is AsyncIterable<T, any, any>
true if the value implements the AsyncIterable interface; otherwise, false.

Since
v1.1.3
- Defined in src/lib/AsyncIterCore.mts:31

`Static`isNot

isNot<T>(value: unknown): value is unknown
Type guard that checks if a value is not an async iterable object.
Type Parameters
- T
  The type of elements contained in the async iterable.
Parameters
- value: unknown
  The value to check for non-async iterability.
Returns value is unknown
true if the value does not implement the AsyncIterable interface; otherwise, false.

Since
v1.1.3
- Defined in src/lib/AsyncIterCore.mts:42

`Static`result

result<V>(value: V): CoreResult<InferAsyncIterable<V>, TypeError>
Creates a CoreResult object which contains the result of the validation check.
Type Parameters
- V
Parameters
- value: V
  The value to check.
Returns CoreResult<InferAsyncIterable<V>, TypeError>
Core Result object.

Since
v1.1.3
- Defined in src/lib/AsyncIterCore.mts:18