Class IterCore

The core iteration functions.

Since

v1.0.0

Index

Methods

assertAsyncIterable assertIterable asyncIterableResult buildValueErr isAsyncIterable isIterable isNotAsyncIterable isNotIterable iterableResult notOneOf oneOf

Methods

`Static`assertAsyncIterable

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

Deprecated
Will be removed in v1.2.0, use AsyncIterCore.assert instead

Throws
If the value is not an async iterable.

Since
v1.0.0
- Defined in src/lib/IterCore.mts:108

`Static`assertIterable

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

Throws
If the value is not an iterable.

Since
v1.0.0
- Defined in src/lib/IterCore.mts:92

`Static`asyncIterableResult

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

Deprecated
Will be removed in v1.2.0, use AsyncIterCore.result instead

Since
v1.1.3
- Defined in src/lib/IterCore.mts:34

`Static`buildValueErr

buildValueErr(
    value: unknown,
    typeName: "AsyncIterable" | "Iterable",
    isNot?: boolean,
): TypeError
Builds value error.
Parameters
- value: unknown
  The invalid value.
- typeName: "AsyncIterable" | "Iterable"
  The expected type name.
- OptionalisNot: boolean = false
  Whether the error should be for !${typeName}.
Returns TypeError
The created error.

Since
v1.1.3
- Defined in src/lib/IterCore.mts:157

`Static`isAsyncIterable

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

Deprecated
Will be removed in v1.2.0, use AsyncIterCore.is instead

Since
v1.0.0
- Defined in src/lib/IterCore.mts:57

`Static`isIterable

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

Since
v1.0.0
- Defined in src/lib/IterCore.mts:45

`Static`isNotAsyncIterable

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

Deprecated
Will be removed in v1.2.0, use AsyncIterCore.isNot instead

Since
v1.0.0
- Defined in src/lib/IterCore.mts:80

`Static`isNotIterable

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

Since
v1.0.0
- Defined in src/lib/IterCore.mts:68

`Static`iterableResult

iterableResult<V>(value: V): CoreResult<InferIterable<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<InferIterable<V>, TypeError>
Core Result object.

Since
v1.1.3
- Defined in src/lib/IterCore.mts:20

`Static`notOneOf

notOneOf<T>(iterables: Iterable<T>, value: T): boolean
Checks if the iterable does not contain the specified value.
Type Parameters
- T
  The type of elements contained in the iterable.
Parameters
- iterables: Iterable<T>
  The iterable to check.
- value: T
  The value to check for.
Returns boolean
true if the iterable does not contain the value; otherwise, false.
Example
```
const values = ['a', 'b', 'c'] as const;
IterCore.notOneOf(values, 'a'); // false
IterCore.notOneOf(values, 'd'); // true
```
Since
v1.1.3
- Defined in src/lib/IterCore.mts:145

`Static`oneOf

oneOf<T>(iterables: Iterable<T>, value: T): boolean
Checks if the iterable contains the specified value.
Type Parameters
- T
  The type of elements contained in the iterable.
Parameters
- iterables: Iterable<T>
  The iterable to check.
- value: T
  The value to check for.
Returns boolean
true if the iterable contains the value; otherwise, false.
Example
```
const values = ['a', 'b', 'c'] as const;
IterCore.oneOf(values, 'a'); // true
IterCore.oneOf(values, 'd'); // false
```
Since
v1.1.3
- Defined in src/lib/IterCore.mts:124

Class IterCore

Since

Index

Methods

Methods

StaticassertAsyncIterable

Type Parameters

Parameters

Returns asserts value is AsyncIterable<T, any, any>

Deprecated

Throws

Since

StaticassertIterable

Type Parameters

Parameters

Returns asserts value is Iterable<T, any, any>

Throws

Since

StaticasyncIterableResult

Type Parameters

Parameters

Returns CoreResult<InferAsyncIterable<V>, TypeError>

Deprecated

Since

StaticbuildValueErr

Parameters

Returns TypeError

Since

StaticisAsyncIterable

Type Parameters

Parameters

Returns value is AsyncIterable<T, any, any>

Deprecated

Since

StaticisIterable

Type Parameters

Parameters

Returns value is Iterable<T, any, any>

Since

StaticisNotAsyncIterable

Type Parameters

Parameters

Returns value is unknown

Deprecated

Since

StaticisNotIterable

Type Parameters

Parameters

Returns value is unknown

Since

StaticiterableResult

Type Parameters

Parameters

Returns CoreResult<InferIterable<V>, TypeError>

Since

StaticnotOneOf

Type Parameters

Parameters

Returns boolean

Example

Since

StaticoneOf

Type Parameters

Parameters

Returns boolean

Example

Since

Settings

On This Page

`Static`assertAsyncIterable

`Static`assertIterable

`Static`asyncIterableResult

`Static`buildValueErr

`Static`isAsyncIterable

`Static`isIterable

`Static`isNotAsyncIterable

`Static`isNotIterable

`Static`iterableResult

`Static`notOneOf

`Static`oneOf