<A>(f: (a: A, i: number) => void): (self: Iterable<A>) => void
<A>(self: Iterable<A>, f: (a: A, i: number) => void): voidRuns a side-effect for each element. The callback receives (element, index).
When to use
Use to iterate over an array for side-effects only, when no transformed result is needed.
Example (Iterating with side-effects)
import { Array } from "effect"
Array.forEach([1, 2, 3], (n) => console.log(n)) // 1, 2, 3export const const forEach: {
<A>(f: (a: A, i: number) => void): (
self: Iterable<A>
) => void
<A>(
self: Iterable<A>,
f: (a: A, i: number) => void
): void
}
Runs a side-effect for each element. The callback receives (element, index).
When to use
Use to iterate over an array for side-effects only, when no transformed
result is needed.
Example (Iterating with side-effects)
import { Array } from "effect"
Array.forEach([1, 2, 3], (n) => console.log(n)) // 1, 2, 3
forEach: {
<function (type parameter) A in <A>(f: (a: A, i: number) => void): (self: Iterable<A>) => voidA>(f: (a: A, i: number) => voidf: (a: Aa: function (type parameter) A in <A>(f: (a: A, i: number) => void): (self: Iterable<A>) => voidA, i: numberi: number) => void): (self: Iterable<A>self: interface Iterable<T, TReturn = any, TNext = any>Iterable<function (type parameter) A in <A>(f: (a: A, i: number) => void): (self: Iterable<A>) => voidA>) => void
<function (type parameter) A in <A>(self: Iterable<A>, f: (a: A, i: number) => void): voidA>(self: Iterable<A>self: interface Iterable<T, TReturn = any, TNext = any>Iterable<function (type parameter) A in <A>(self: Iterable<A>, f: (a: A, i: number) => void): voidA>, f: (a: A, i: number) => voidf: (a: Aa: function (type parameter) A in <A>(self: Iterable<A>, f: (a: A, i: number) => void): voidA, i: numberi: number) => void): void
} = dual<(...args: Array<any>) => any, <A>(self: Iterable<A>, f: (a: A, i: number) => void) => void>(arity: 2, body: <A>(self: Iterable<A>, f: (a: A, i: number) => void) => void): ((...args: Array<any>) => any) & (<A>(self: Iterable<A>, f: (a: A, i: number) => void) => void) (+1 overload)Creates a function that can be called in data-first style or data-last
(pipe-friendly) style.
When to use
Use to expose one implementation through both direct and pipe-friendly
call styles.
Details
Pass either the arity of the uncurried function or a predicate that decides
whether the current call is data-first. Arity is the common case. Use a
predicate when optional arguments make arity ambiguous.
Example (Selecting data-first or data-last style by arity)
import { Function, pipe } from "effect"
const sum = Function.dual<
(that: number) => (self: number) => number,
(self: number, that: number) => number
>(2, (self, that) => self + that)
console.log(sum(2, 3)) // 5
console.log(pipe(2, sum(3))) // 5
Example (Defining overloads with call signatures)
import { Function, pipe } from "effect"
const sum: {
(that: number): (self: number) => number
(self: number, that: number): number
} = Function.dual(2, (self: number, that: number): number => self + that)
console.log(sum(2, 3)) // 5
console.log(pipe(2, sum(3))) // 5
Example (Selecting data-first or data-last style with a predicate)
import { Function, pipe } from "effect"
const sum = Function.dual<
(that: number) => (self: number) => number,
(self: number, that: number) => number
>(
(args) => args.length === 2,
(self, that) => self + that
)
console.log(sum(2, 3)) // 5
console.log(pipe(2, sum(3))) // 5
dual(2, <function (type parameter) A in <A>(self: Iterable<A>, f: (a: A, i: number) => void): voidA>(self: Iterable<A>self: interface Iterable<T, TReturn = any, TNext = any>Iterable<function (type parameter) A in <A>(self: Iterable<A>, f: (a: A, i: number) => void): voidA>, f: (a: A, i: number) => voidf: (a: Aa: function (type parameter) A in <A>(self: Iterable<A>, f: (a: A, i: number) => void): voidA, i: numberi: number) => void): void => const fromIterable: <A>(
collection: Iterable<A>
) => A[]
Converts an Iterable to an Array.
When to use
Use to convert any Iterable (Set, Generator, etc.) into an array.
Details
If the input is already an array, this returns it by reference without
copying. Otherwise, it creates a new array from the iterable. Use copy if
you need a fresh array even when the input is already an array.
Example (Converting a Set to an array)
import { Array } from "effect"
const result = Array.fromIterable(new Set([1, 2, 3]))
console.log(result) // [1, 2, 3]
fromIterable(self: Iterable<A>self).Array<A>.forEach(callbackfn: (value: A, index: number, array: A[]) => void, thisArg?: any): voidPerforms the specified action for each element in an array.
forEach((a: Aa, i: numberi) => f: (a: A, i: number) => voidf(a: Aa, i: numberi)))