Interface Tuple<T>

Foldable type class represents data structures that can be folded to a summary value.

interface Tuple<T extends Type[]> {
 _tag: "Tuple";
 length: number;
 "[iterator]"(): Iterator<T[number]>;
 flatMap(f: (value: T) => Tuple): Tuple;
 fold(onEmpty: () => B, onValue: (value: T[number]) => B): B;
 foldLeft(z: B): (op: (b: B, a: T[number]) => B) => B;
 foldRight(z: B): (op: (a: T[number], b: B) => B) => B;
 get<K extends number>(index: K): T[K];
 map(f: (value: T) => U): Tuple;
 pipe(f: (value: Tuple) => U): U;
 serialize(): SerializationMethods<Tuple<T>>;
 toArray(): T;
 toString(): string;
 toValue(): { _tag: "Tuple"; value: T };
}

Type Parameters

T extends Type[]
The type of elements in the data structure

Hierarchy (View Summary)

Foldable<T[number]>
Pipe<Tuple<T>>
Serializable<Tuple<T>>
Typeable<"Tuple">
- Tuple

Index

Properties

_tag length

Methods

[iterator] flatMap fold foldLeft foldRight get map pipe serialize toArray toString toValue

Properties

`Readonly`_tag

_tag: "Tuple"

length

length: number

Methods

[iterator]

"[iterator]"(): Iterator<T[number]>
Returns Iterator<T[number]>

flatMap

flatMap(f: (value: T) => Tuple): Tuple
Type Parameters
- U extends unknown[]
Parameters
- f: (value: T) => Tuple
Returns Tuple

fold

fold(onEmpty: () => B, onValue: (value: T[number]) => B): B
Pattern matches over the structure, applying specific handlers for each variant
Type Parameters
- B
Parameters
- onEmpty: () => B
 Function to apply if the structure is empty or has no value
- onValue: (value: T[number]) => B
 Function to apply if the structure has a value
Returns B
The result of applying the appropriate function

Inherited from Foldable.fold

foldLeft

foldLeft(z: B): (op: (b: B, a: T[number]) => B) => B
Left-associative fold using the provided zero value and operation
Type Parameters
- B
Parameters
- z: B
 Zero/identity value
Returns (op: (b: B, a: T[number]) => B) => B
A function that takes an operation to apply

Inherited from Foldable.foldLeft

foldRight

foldRight(z: B): (op: (a: T[number], b: B) => B) => B
Right-associative fold using the provided zero value and operation
Type Parameters
- B
Parameters
- z: B
 Zero/identity value
Returns (op: (a: T[number], b: B) => B) => B
A function that takes an operation to apply

Inherited from Foldable.foldRight

get

get<K extends number>(index: K): T[K]
Type Parameters
- K extends number
Parameters
- index: K
Returns T[K]

map

map(f: (value: T) => U): Tuple
Type Parameters
- U extends unknown[]
Parameters
- f: (value: T) => U
Returns Tuple

pipe

pipe(f: (value: Tuple) => U): U
Pipes the value through the provided function
Type Parameters
- U extends unknown
 The return type of the function
Parameters
- f: (value: Tuple) => U
 The function to apply to the value
Returns U
The result of applying the function to the value

Inherited from Pipe.pipe

serialize

serialize(): SerializationMethods<Tuple<T>>
Returns SerializationMethods<Tuple<T>>
Inherited from Serializable.serialize

toArray

toArray(): T
Returns T

toString

toString(): string
Returns a string representation of an object.

Returns string

toValue

toValue(): { _tag: "Tuple"; value: T }
Returns { _tag: "Tuple"; value: T }

Interface Tuple<T>

Type Parameters

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Readonly_tag

length

Methods

[iterator]

Returns Iterator<T[number]>

flatMap

Type Parameters

Parameters

Returns Tuple<U>

fold

Type Parameters

Parameters

Returns B

foldLeft

Type Parameters

Parameters

Returns (op: (b: B, a: T[number]) => B) => B

foldRight

Type Parameters

Parameters

Returns (op: (a: T[number], b: B) => B) => B

get

Type Parameters

Parameters

Returns T[K]

map

Type Parameters

Parameters

Returns Tuple<U>

pipe

Type Parameters

Parameters

Returns U

serialize

Returns SerializationMethods<Tuple<T>>

toArray

Returns T

toString

Returns string

toValue

Returns { _tag: "Tuple"; value: T }

Settings

On This Page

`Readonly`_tag