--- title: FxT.ts nav_order: 29 parent: Modules --- ## FxT overview Added in v0.13.0 ---

- [Combinator](#combinator) - [ap](#ap) - [chain](#chain) - [chainRec](#chainrec) - [map](#map) - [provideAll](#provideall) - [provideSome](#providesome) - [useAll](#useall) - [useSome](#usesome) - [Constructor](#constructor) - [ask](#ask) - [liftFx](#liftfx) - [of](#of) - [Interpreter](#interpreter) - [toMonad](#tomonad) - [Lift](#lift) - [getDo](#getdo) - [Model](#model) - [FxT (type alias)](#fxt-type-alias) - [Natural Transformation](#natural-transformation) - [fromNaturalTransformation](#fromnaturaltransformation) - [Type-level](#type-level) - [ChainRecFxT (type alias)](#chainrecfxt-type-alias) - [LiftFx (type alias)](#liftfx-type-alias) - [LiftFx1 (type alias)](#liftfx1-type-alias) - [LiftFx2 (type alias)](#liftfx2-type-alias) - [LiftFx3 (type alias)](#liftfx3-type-alias) - [LiftFx4 (type alias)](#liftfx4-type-alias) - [LiftFxHKT (type alias)](#liftfxhkt-type-alias) --- # Combinator ## ap **Signature** ```ts export declare function ap( M: MonadRec1 & Apply1, ): (fa: FxT) => (fab: FxT]>) => FxT export declare function ap( M: MonadRec2 & Apply2, ): ( fa: FxT, ) => (fab: FxT]>) => FxT, B]> export declare function ap( M: MonadRec2 & Apply2, ): (fa: FxT) => (fab: FxT]>) => FxT export declare function ap( M: MonadRec3 & Apply3, ): ( fa: FxT, ) => ( fab: FxT]>, ) => FxT, ApplyVariance, B]> export declare function ap( M: MonadRec4 & Apply4, ): ( fa: FxT, ) => ( fab: FxT]>, ) => FxT< F, [ ApplyVariance, ApplyVariance, ApplyVariance, B, ] > export declare function ap( M: MonadRec & Apply, ): (fa: FxT) => (fab: FxT]>) => FxT ``` Added in v0.13.0 ## chain **Signature** ```ts export declare function chain(): ( f: (value: A) => FxT, ) => (fx: FxT) => FxT]> export declare function chain(): ( f: (value: A) => FxT, ) => (fx: FxT) => FxT, B]> export declare function chain(): ( f: (value: A) => FxT, ) => ( fx: FxT, ) => FxT< F, [ApplyVariance, ApplyVariance, ApplyVariance] > export declare function chain(): ( f: (value: A) => FxT, ) => ( fx: FxT, ) => FxT< F, [ ApplyVariance, ApplyVariance, ApplyVariance, ApplyVariance, ] > export declare function chain(): ( f: (value: A) => FxT, ) => (fx: FxT) => FxT ``` Added in v0.13.0 ## chainRec **Signature** ```ts export declare function chainRec(M: MonadRec1): ChainRecFxT export declare function chainRec(M: MonadRec2): ChainRecFxT export declare function chainRec(M: MonadRec3): ChainRecFxT export declare function chainRec(M: MonadRec4): ChainRecFxT ``` Added in v0.13.0 ## map **Signature** ```ts export declare function map(): ( f: (value: A) => B, ) => (fx: FxT) => FxT export declare function map(): ( f: (value: A) => B, ) => (fx: FxT) => FxT export declare function map(): ( f: (value: A) => B, ) => (fx: FxT) => FxT export declare function map(): ( f: (value: A) => B, ) => (fx: FxT) => FxT export declare function map(): (f: (value: A) => B) => (fx: FxT) => FxT ``` Added in v0.13.0 ## provideAll **Signature** ```ts export declare function provideAll( M: ProvideAll2 & MonadRec2, ): (provided: A) => (fx: Fx, T>) => Fx, T> export declare function provideAll( M: ProvideAll3 & MonadRec3, ): ( provided: A, ) => (fx: Fx, T>) => Fx, T> export declare function provideAll( M: ProvideAll4 & MonadRec4, ): ( provided: A, ) => (fx: Fx, T>) => Fx, T> export declare function provideAll( M: ProvideAll & MonadRec, ): (provided: A) => (fx: Fx, T>) => Fx, T> ``` Added in v0.13.0 ## provideSome **Signature** ```ts export declare function provideSome( M: ProvideSome2 & MonadRec2, ): (provided: A) => (fx: Fx, T>) => Fx, T> export declare function provideSome( M: ProvideSome3 & MonadRec3, ): ( provided: A, ) => (fx: Fx, T>) => Fx, T> export declare function provideSome( M: ProvideSome4 & MonadRec4, ): ( provided: A, ) => (fx: Fx, T>) => Fx, T> export declare function provideSome( M: ProvideSome & MonadRec, ): (provided: A) => (fx: Fx, T>) => Fx, T> ``` Added in v0.13.0 ## useAll **Signature** ```ts export declare function useAll( M: UseAll2 & MonadRec2, ): (provided: A) => (fx: Fx, T>) => Fx, T> export declare function useAll( M: UseAll3 & MonadRec3, ): ( provided: A, ) => (fx: Fx, T>) => Fx, T> export declare function useAll( M: UseAll4 & MonadRec4, ): ( provided: A, ) => (fx: Fx, T>) => Fx, T> export declare function useAll( M: UseAll & MonadRec, ): (provided: A) => (fx: Fx, T>) => Fx, T> ``` Added in v0.13.0 ## useSome **Signature** ```ts export declare function useSome( M: UseSome2 & MonadRec2, ): (provided: A) => (fx: Fx, T>) => Fx, T> export declare function useSome( M: UseSome3 & MonadRec3, ): ( provided: A, ) => (fx: Fx, T>) => Fx, T> export declare function useSome( M: UseSome4 & MonadRec4, ): ( provided: A, ) => (fx: Fx, T>) => Fx, T> export declare function useSome( M: UseSome & MonadRec, ): (provided: A) => (fx: Fx, T>) => Fx, T> ``` Added in v0.13.0 # Constructor ## ask **Signature** ```ts export declare function ask(M: FromReader2): () => Fx, A> export declare function ask( M: FromReader3, ): () => Fx, A]>, A> export declare function ask( M: FromReader3C, ): () => Fx, A> export declare function ask( M: FromReader4, ): () => Fx, A, Initial, A]>, A> export declare function ask(M: FromReader): () => Fx, A> ``` Added in v0.13.0 ## liftFx Create a lift function that will convert any F into Fx, A> **Signature** ```ts export declare const liftFx: () => LiftFx ``` Added in v0.13.0 ## of **Signature** ```ts export declare function of(M: Pointed1): (value: A) => Fx, A> export declare function of( M: Pointed2, ): >(value: A) => Fx, A> export declare function of( M: Pointed3, ): , E = Initial>(value: A) => Fx, A> export declare function of( M: Pointed4, ): , R = Initial, E = Initial>( value: A, ) => Fx, A> export declare function of(M: Pointed): (value: A) => Fx, A> ``` Added in v0.13.0 # Interpreter ## toMonad **Signature** ```ts export declare function toMonad( M: MonadRec1, ): , R>(fx: Fx) => Kind export declare function toMonad( M: MonadRec2, ): , R>( fx: Fx, ) => Kind2>>, R> export declare function toMonad( M: MonadRec2C, ): , R>(fx: Fx) => Kind2 export declare function toMonad( M: MonadRec3, ): , R>( fx: Fx, ) => Kind3< F, ApplyVariance>>, ApplyVariance>>, R > export declare function toMonad( M: MonadRec4, ): , R>( fx: Fx, ) => Kind4< F, ApplyVariance>>, ApplyVariance>>, ApplyVariance>>, R > export declare function toMonad(M: MonadRec): (fx: Fx) => HKT ``` Added in v0.13.0 # Lift ## getDo **Signature** ```ts export declare function getDo(): , R, N = unknown>( f: (lift: LiftFx1) => Generator, ) => Fx export declare function getDo(): < Y extends Kind2, R, N = unknown, >( f: (lift: LiftFx2) => Generator, ) => Fx export declare function getDo(): < Y extends Kind3, Z, N = unknown, >( f: (lift: LiftFx3) => Generator, ) => Fx export declare function getDo(): < Y extends Kind4, Z, N = unknown, >( f: (lift: LiftFx4) => Generator, ) => Fx export declare function getDo(): , R, N = unknown>( f: (lift: LiftFxHKT) => Generator, ) => Fx ``` Added in v0.13.0 # Model ## FxT (type alias) **Signature** ```ts export type FxT = Params extends readonly [...infer Init, infer R] ? Fx, R> : never ``` Added in v0.13.0 # Natural Transformation ## fromNaturalTransformation **Signature** ```ts export declare function fromNaturalTransformation( transformation: NaturalTransformation11, ): (fa: Kind) => Fx, A> export declare function fromNaturalTransformation( transformation: NaturalTransformation12, ): >(fa: Kind) => Fx, A> export declare function fromNaturalTransformation( transformation: NaturalTransformation12C, ): (fa: Kind) => Fx, A> export declare function fromNaturalTransformation( transformation: NaturalTransformation13, ): , E = Initial>(fa: Kind) => Fx, A> export declare function fromNaturalTransformation( transformation: NaturalTransformation13C, ): >(fa: Kind) => Fx, A> export declare function fromNaturalTransformation( transformation: NaturalTransformation14, ): , R = Initial, E = Initial>( fa: Kind, ) => Fx, A> export declare function fromNaturalTransformation( transformation: NaturalTransformation14C, ): , R = Initial>(fa: Kind) => Fx, A> export declare function fromNaturalTransformation( transformation: NaturalTransformation21, ): (fa: Kind2) => Fx, A> export declare function fromNaturalTransformation( transformation: NaturalTransformation22, ): (fa: Kind2) => Fx, A> export declare function fromNaturalTransformation( transformation: NaturalTransformation22C, ): (fa: Kind2) => Fx, A> export declare function fromNaturalTransformation( transformation: NaturalTransformation23 | NaturalTransformation23R, ): >(fa: Kind2) => Fx, A> export declare function fromNaturalTransformation( transformation: NaturalTransformation23C, ): >(fa: Kind2) => Fx, A> export declare function fromNaturalTransformation( transformation: | NaturalTransformation24 | NaturalTransformation24R | NaturalTransformation24S, ): , R = Initial>( fa: Kind2, ) => Fx, A> export declare function fromNaturalTransformation( transformation: NaturalTransformation33, ): (fa: Kind3) => Fx, A> export declare function fromNaturalTransformation( transformation: NaturalTransformation34, ): >(fa: Kind3) => Fx, A> export declare function fromNaturalTransformation( transformation: NaturalTransformation, ): (fa: HKT) => Fx, A> ``` Added in v0.13.0 # Type-level ## ChainRecFxT (type alias) **Signature** ```ts export type ChainRecFxT = F extends URIS2 ? (f: Arity1]>>) => (a: A) => FxT : F extends URIS3 ? (f: Arity1]>>) => (a: A) => FxT : F extends URIS4 ? (f: Arity1]>>) => (a: A) => FxT : (f: Arity1]>>) => (a: A) => FxT ``` Added in v0.13.0 ## LiftFx (type alias) **Signature** ```ts export type LiftFx = F extends URIS ? LiftFx1 : F extends URIS2 ? LiftFx2 : F extends URIS3 ? LiftFx3 : F extends URIS4 ? LiftFx4 : LiftFxHKT ``` Added in v0.13.0 ## LiftFx1 (type alias) **Signature** ```ts export type LiftFx1 = (kind: Kind) => Fx, A> ``` Added in v0.13.0 ## LiftFx2 (type alias) **Signature** ```ts export type LiftFx2 = ( kind: Kind2, A>, ) => Fx, A>, A> ``` Added in v0.13.0 ## LiftFx3 (type alias) **Signature** ```ts export type LiftFx3 = ( kind: Kind3, E, A>, ) => Fx, E, A>, A> ``` Added in v0.13.0 ## LiftFx4 (type alias) **Signature** ```ts export type LiftFx4 = ( kind: Kind4, E, A>, ) => Fx, E, A>, A> ``` Added in v0.13.0 ## LiftFxHKT (type alias) **Signature** ```ts export type LiftFxHKT = (kind: HKT) => Fx, A> ``` Added in v0.13.0

Table of contents