effect-io-ai

Package: effect
Module: Predicate

Predicate.isIterable

A refinement that checks if a value is an Iterable. Many built-in types are iterable, such as Array, string, Map, and Set.

Example

import * as assert from "node:assert"
import { isIterable } from "effect/Predicate"

assert.strictEqual(isIterable([]), true)
assert.strictEqual(isIterable("hello"), true)
assert.strictEqual(isIterable(new Set()), true)

assert.strictEqual(isIterable({}), false)
assert.strictEqual(isIterable(123), false)

Signature

declare const isIterable: (input: unknown) => input is Iterable<unknown>

Source

Since v2.0.0