ReadonlyTuple overview

Added in v2.5.0

---

Table of contents

• Extract
  • extract
• error handling
  • mapLeft
• folding
  • foldMap
  • reduce
  • reduceRight
• instances
  • Bifunctor
  • Comonad
  • Foldable
  • Functor
  • Semigroupoid
  • Traversable
  • getApplicative
  • getApply
  • getChain
  • getChainRec
  • getMonad
• mapping
  • bimap
  • flap
  • map
  • mapFst
  • mapSnd
• traversing
  • sequence
  • traverse
• type lambdas
  • URI
  • URI (type alias)
• utils
  • compose
  • duplicate
  • extend
  • fst
  • snd
  • swap
• zone of death
  • readonlyTuple

---

Extract

extract

Signature

export declare const extract: <E, A>(wa: readonly [A, E]) => A

Added in v2.6.2

error handling

mapLeft

Alias of mapSnd.

Signature

export declare const mapLeft: <E, G>(f: (e: E) => G) => <A>(fa: readonly [A, E]) => readonly [A, G]

Added in v2.5.0

folding

foldMap

Signature

export declare const foldMap: <M>(M: Monoid<M>) => <A>(f: (a: A) => M) => <E>(fa: readonly [A, E]) => M

Added in v2.5.0

reduce

Signature

export declare const reduce: <A, B>(b: B, f: (b: B, a: A) => B) => <E>(fa: readonly [A, E]) => B

Added in v2.5.0

reduceRight

Signature

export declare const reduceRight: <A, B>(b: B, f: (a: A, b: B) => B) => <E>(fa: readonly [A, E]) => B

Added in v2.5.0

instances

Bifunctor

Signature

export declare const Bifunctor: Bifunctor2<'ReadonlyTuple'>

Added in v2.7.0

Comonad

Signature

export declare const Comonad: Comonad2<'ReadonlyTuple'>

Added in v2.7.0

Foldable

Signature

export declare const Foldable: Foldable2<'ReadonlyTuple'>

Added in v2.7.0

Functor

Signature

export declare const Functor: Functor2<'ReadonlyTuple'>

Added in v2.7.0

Semigroupoid

Signature

export declare const Semigroupoid: Semigroupoid2<'ReadonlyTuple'>

Added in v2.7.0

Traversable

Signature

export declare const Traversable: Traversable2<'ReadonlyTuple'>

Added in v2.7.0

getApplicative

Signature

export declare function getApplicative<M>(M: Monoid<M>): Applicative2C<URI, M>

Added in v2.5.0

getApply

Signature

export declare function getApply<S>(S: Semigroup<S>): Apply2C<URI, S>

Added in v2.5.0

getChain

Signature

export declare function getChain<S>(S: Semigroup<S>): Chain2C<URI, S>

Added in v2.5.0

getChainRec

Signature

export declare function getChainRec<M>(M: Monoid<M>): ChainRec2C<URI, M>

Added in v2.5.0

getMonad

Signature

export declare function getMonad<M>(M: Monoid<M>): Monad2C<URI, M>

Added in v2.5.0

mapping

bimap

Map a pair of functions over the two type arguments of the bifunctor.

Signature

export declare const bimap: <E, G, A, B>(
  mapSnd: (e: E) => G,
  mapFst: (a: A) => B
) => (fa: readonly [A, E]) => readonly [B, G]

Added in v2.5.0

flap

Signature

export declare const flap: <A>(a: A) => <E, B>(fab: readonly [(a: A) => B, E]) => readonly [B, E]

Added in v2.10.0

map

Alias of mapFst.

Signature

export declare const map: <A, B>(f: (a: A) => B) => <E>(fa: readonly [A, E]) => readonly [B, E]

Added in v2.5.0

mapFst

Map a function over the first component of a ReadonlyTuple.

This is the map operation of the Functor instance.

Signature

export declare const mapFst: <A, B>(f: (a: A) => B) => <E>(fa: readonly [A, E]) => readonly [B, E]

Added in v2.10.0

mapSnd

Map a function over the second component of a ReadonlyTuple.

This is the mapLeft operation of the Bifunctor instance.

Signature

export declare const mapSnd: <E, G>(f: (e: E) => G) => <A>(fa: readonly [A, E]) => readonly [A, G]

Added in v2.10.0

traversing

sequence

Signature

export declare const sequence: Sequence2<'ReadonlyTuple'>

Added in v2.6.3

traverse

Signature

export declare const traverse: PipeableTraverse2<'ReadonlyTuple'>

Added in v2.6.3

type lambdas

URI

Signature

export declare const URI: 'ReadonlyTuple'

Added in v2.5.0

URI (type alias)

Signature

export type URI = typeof URI

Added in v2.5.0

utils

compose

Signature

export declare const compose: <A, B>(ab: readonly [B, A]) => <C>(bc: readonly [C, B]) => readonly [C, A]

Added in v2.5.0

duplicate

Signature

export declare const duplicate: <E, A>(wa: readonly [A, E]) => readonly [readonly [A, E], E]

Added in v2.5.0

extend

Signature

export declare const extend: <E, A, B>(f: (wa: readonly [A, E]) => B) => (wa: readonly [A, E]) => readonly [B, E]

Added in v2.5.0

fst

Signature

export declare function fst<A, E>(ea: readonly [A, E]): A

Added in v2.5.0

snd

Signature

export declare function snd<A, E>(ea: readonly [A, E]): E

Added in v2.5.0

swap

Signature

export declare const swap: <A, E>(ea: readonly [A, E]) => readonly [E, A]

Added in v2.5.0

zone of death

readonlyTuple

This instance is deprecated, use small, specific instances instead. For example if a function needs a Functor instance, pass RT.Functor instead of RT.readonlyTuple (where RT is from import RT from 'fp-ts/ReadonlyTuple')

Signature

export declare const readonlyTuple: Semigroupoid2<'ReadonlyTuple'> &
  Bifunctor2<'ReadonlyTuple'> &
  Comonad2<'ReadonlyTuple'> &
  Foldable2<'ReadonlyTuple'> &
  Traversable2<'ReadonlyTuple'>

Added in v2.5.0