fp-ts

This site uses Just the Docs, a documentation theme for Jekyll.

Search

Table of contents

URI (type alias)

Signature

export type URI = typeof URI

Store (class)

Signature

export class Store<S, A> {
  constructor(readonly peek: (s: S) => A, readonly pos: S) { ... }
  ...
}

Added in v1.0.0

seek (method)

Reposition the focus at the specified position

Signature

seek(s: S): Store<S, A> { ... }

map (method)

Signature

map<B>(f: (a: A) => B): Store<S, B> { ... }

extract (method)

Signature

extract(): A { ... }

extend (method)

Signature

extend<B>(f: (sa: Store<S, A>) => B): Store<S, B> { ... }

inspect (method)

Signature

inspect(): string { ... }

toString (method)

Signature

toString(): string { ... }

URI (constant)

Signature

export const URI = ...

store (constant)

Signature

export const store: Comonad2<URI> = ...

Added in v1.0.0

experiment (function)

Extract a collection of values from positions which depend on the current position

Signature

export function experiment<F extends URIS3>(
  F: Functor3<F>
): <U, L, S>(f: (s: S) => HKT3<F, U, L, S>) => <A>(sa: Store<S, A>) => Type3<F, U, L, A>
export function experiment<F extends URIS2>(
  F: Functor2<F>
): <L, S>(f: (s: S) => HKT2<F, L, S>) => <A>(sa: Store<S, A>) => Type2<F, L, A>
export function experiment<F extends URIS>(
  F: Functor<F>
): <S>(f: (s: S) => HKT<F, S>) => <A>(sa: Store<S, A>) => Type<F, A>
export function experiment<F>(F: Functor<F>): <S>(f: (s: S) => HKT<F, S>) => <A>(sa: Store<S, A>) => HKT<F, A> { ... }

Added in v1.0.0

peeks (function)

Extract a value from a position which depends on the current position

Signature

export const peeks = <S>(f: Endomorphism<S>) => <A>(sa: Store<S, A>) => (s: S): A => ...

Added in v1.0.0

seeks (function)

Reposition the focus at the specified position, which depends on the current position

Signature

export const seeks = <S>(f: Endomorphism<S>) => <A>(sa: Store<S, A>): Store<S, A> => ...

Added in v1.0.0