<B>(that: Iterable<B>): <A>(self: Iterable<A>) => Iterable<[A, B]>
<A, B>(self: Iterable<A>, that: Iterable<B>): Iterable<[A, B]>Zips this Iterable crosswise with the specified Iterable.
Example (Generating cartesian pairs)
import { Iterable } from "effect"
// All pairs of numbers and letters
const numbers = [1, 2, 3]
const letters = ["a", "b"]
const pairs = Iterable.cartesian(numbers, letters)
console.log(Array.from(pairs))
// [[1, "a"], [1, "b"], [2, "a"], [2, "b"], [3, "a"], [3, "b"]]
// Generate coordinate grid
const x = [0, 1, 2]
const y = [0, 1]
const grid = Iterable.cartesian(x, y)
console.log(Array.from(grid))
// [[0, 0], [0, 1], [1, 0], [1, 1], [2, 0], [2, 1]]
// All combinations for testing
const browsers = ["chrome", "firefox"]
const devices = ["desktop", "mobile", "tablet"]
const testMatrix = Iterable.cartesian(browsers, devices)
console.log(Array.from(testMatrix))
// [
// ["chrome", "desktop"], ["chrome", "mobile"], ["chrome", "tablet"],
// ["firefox", "desktop"], ["firefox", "mobile"], ["firefox", "tablet"]
// ]
// Empty iterable results in empty cartesian product
const empty = Iterable.empty<number>()
const withEmpty = Iterable.cartesian([1, 2], empty)
console.log(Array.from(withEmpty)) // []export const const cartesian: {
<B>(that: Iterable<B>): <A>(
self: Iterable<A>
) => Iterable<[A, B]>
<A, B>(
self: Iterable<A>,
that: Iterable<B>
): Iterable<[A, B]>
}
Zips this Iterable crosswise with the specified Iterable.
Example (Generating cartesian pairs)
import { Iterable } from "effect"
// All pairs of numbers and letters
const numbers = [1, 2, 3]
const letters = ["a", "b"]
const pairs = Iterable.cartesian(numbers, letters)
console.log(Array.from(pairs))
// [[1, "a"], [1, "b"], [2, "a"], [2, "b"], [3, "a"], [3, "b"]]
// Generate coordinate grid
const x = [0, 1, 2]
const y = [0, 1]
const grid = Iterable.cartesian(x, y)
console.log(Array.from(grid))
// [[0, 0], [0, 1], [1, 0], [1, 1], [2, 0], [2, 1]]
// All combinations for testing
const browsers = ["chrome", "firefox"]
const devices = ["desktop", "mobile", "tablet"]
const testMatrix = Iterable.cartesian(browsers, devices)
console.log(Array.from(testMatrix))
// [
// ["chrome", "desktop"], ["chrome", "mobile"], ["chrome", "tablet"],
// ["firefox", "desktop"], ["firefox", "mobile"], ["firefox", "tablet"]
// ]
// Empty iterable results in empty cartesian product
const empty = Iterable.empty<number>()
const withEmpty = Iterable.cartesian([1, 2], empty)
console.log(Array.from(withEmpty)) // []
cartesian: {
<function (type parameter) B in <B>(that: Iterable<B>): <A>(self: Iterable<A>) => Iterable<[A, B]>B>(that: Iterable<B>that: interface Iterable<T, TReturn = any, TNext = any>Iterable<function (type parameter) B in <B>(that: Iterable<B>): <A>(self: Iterable<A>) => Iterable<[A, B]>B>): <function (type parameter) A in <A>(self: Iterable<A>): Iterable<[A, B]>A>(self: Iterable<A>self: interface Iterable<T, TReturn = any, TNext = any>Iterable<function (type parameter) A in <A>(self: Iterable<A>): Iterable<[A, B]>A>) => interface Iterable<T, TReturn = any, TNext = any>Iterable<[function (type parameter) A in <A>(self: Iterable<A>): Iterable<[A, B]>A, function (type parameter) B in <B>(that: Iterable<B>): <A>(self: Iterable<A>) => Iterable<[A, B]>B]>
<function (type parameter) A in <A, B>(self: Iterable<A>, that: Iterable<B>): Iterable<[A, B]>A, function (type parameter) B in <A, B>(self: Iterable<A>, that: Iterable<B>): Iterable<[A, B]>B>(self: Iterable<A>self: interface Iterable<T, TReturn = any, TNext = any>Iterable<function (type parameter) A in <A, B>(self: Iterable<A>, that: Iterable<B>): Iterable<[A, B]>A>, that: Iterable<B>that: interface Iterable<T, TReturn = any, TNext = any>Iterable<function (type parameter) B in <A, B>(self: Iterable<A>, that: Iterable<B>): Iterable<[A, B]>B>): interface Iterable<T, TReturn = any, TNext = any>Iterable<[function (type parameter) A in <A, B>(self: Iterable<A>, that: Iterable<B>): Iterable<[A, B]>A, function (type parameter) B in <A, B>(self: Iterable<A>, that: Iterable<B>): Iterable<[A, B]>B]>
} = dual<(...args: Array<any>) => any, <A, B>(self: Iterable<A>, that: Iterable<B>) => Iterable<[A, B]>>(arity: 2, body: <A, B>(self: Iterable<A>, that: Iterable<B>) => Iterable<[A, B]>): ((...args: Array<any>) => any) & (<A, B>(self: Iterable<A>, that: Iterable<B>) => Iterable<[A, B]>) (+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, B>(self: Iterable<A>, that: Iterable<B>): Iterable<[A, B]>A, function (type parameter) B in <A, B>(self: Iterable<A>, that: Iterable<B>): Iterable<[A, B]>B>(self: Iterable<A>self: interface Iterable<T, TReturn = any, TNext = any>Iterable<function (type parameter) A in <A, B>(self: Iterable<A>, that: Iterable<B>): Iterable<[A, B]>A>, that: Iterable<B>that: interface Iterable<T, TReturn = any, TNext = any>Iterable<function (type parameter) B in <A, B>(self: Iterable<A>, that: Iterable<B>): Iterable<[A, B]>B>): interface Iterable<T, TReturn = any, TNext = any>Iterable<[function (type parameter) A in <A, B>(self: Iterable<A>, that: Iterable<B>): Iterable<[A, B]>A, function (type parameter) B in <A, B>(self: Iterable<A>, that: Iterable<B>): Iterable<[A, B]>B]> => const cartesianWith: <A, B, [A, B]>(self: Iterable<A>, that: Iterable<B>, f: (a: A, b: B) => [A, B]) => Iterable<[A, B]> (+1 overload)cartesianWith(self: Iterable<A>self, that: Iterable<B>that, (a: Aa, b: Bb) => [a: Aa, b: Bb])
)