Skip to main content Link Search Menu Expand Document (external link)

List overview

Added in v0.0.0


Table of contents


combinators

append

Signature

export declare const append: (<A>(value: A) => (self: List<A>) => List<A>) & (<A>(self: List<A>, value: A) => List<A>)

Added in v0.0.0

map

Signature

export declare const map: (<A, B>(f: (value: A, index: number) => B) => (self: List<A>) => List<B>) &
  (<A, B>(self: List<A>, f: (value: A, index: number) => B) => List<B>)

Added in v0.0.0

constructors

cons

Signature

export declare const cons: (<A>(value: A) => (self: List<A>) => List<A>) & (<A>(self: List<A>, value: A) => List<A>)

Added in v0.0.0

empty

Signature

export declare const empty: <A = never>() => internal.List<A>

Added in v0.0.0

fromIterable

Signature

export declare const fromIterable: <A>(iterable: Iterable<A>) => internal.List<A>

Added in v0.0.0

of

Signature

export declare const of: <A>(...values: ReadonlyArray<A>) => internal.List<A>

Added in v0.0.0

folding

reduce

Signature

export declare const reduce: (<A, B>(
  initial: B,
  f: (accumulator: B, value: A, index: number) => B
) => (self: List<A>) => B) &
  (<A, B>(self: List<A>, initial: B, f: (accumulator: B, value: A, index: number) => B) => B)

Added in v0.0.0

getters

toArray

Signature

export declare const toArray: <A>(self: internal.List<A>) => Array<A>

Added in v0.0.0

models

List (interface)

Signature

export interface List<A> extends internal.List<A> {}

Added in v0.0.0

refinements

isList

Signature

export declare const isList: (u: unknown) => u is internal.List<unknown>

Added in v0.0.0

traversing

forEachEffect

Signature

export declare const forEachEffect: (<A, E, R>(
  f: (value: A, index: number) => Effect.Effect<void, E, R>
) => (self: List<A>) => Effect.Effect<void, E, R>) &
  (<A, E, R>(self: List<A>, f: (value: A, index: number) => Effect.Effect<void, E, R>) => Effect.Effect<void, E, R>)

Added in v0.0.0

type id

TypeId

Signature

export declare const TypeId: typeof internal.TypeId

Added in v0.0.0

TypeId (type alias)

Signature

export type TypeId = internal.TypeId

Added in v0.0.0