Options
All
  • Public
  • Public/Protected
  • All
Menu

@ezy/makina

Index

Modules

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

Lens

Lens<S, A>: (functorFactory: (a: A) => Functor<A>) => (s: S) => Functor<S>

functional lens

Type parameters

  • S

  • A

Type declaration

    • (functorFactory: (a: A) => Functor<A>): (s: S) => Functor<S>

    • Parameters

      • functorFactory: (a: A) => Functor<A>
          • (a: A): Functor<A>

          • Parameters

            • a: A

            Returns Functor<A>

      Returns (s: S) => Functor<S>

        • (s: S): Functor<S>

        • Parameters

          • s: S

          Returns Functor<S>

StateContainerClass

StateContainerClass: WithoutConstructor<typeof StateContainer> & Constructor<StateContainer<any, any>>

StateContainerTree

StateContainerTree<S>: {}

Type parameters

Type declaration

StateTree

StateTree<S>: {}

Type parameters

Type declaration

modulesOptions

modulesOptions: {}

Type declaration

statesOptions

statesOptions: {}

Type declaration

  • [key: string]: { from: Array<any>; is: (state: any) => boolean; set: (state: any, ...args: any[]) => any }
    • from: Array<any>
    • is: (state: any) => boolean
        • (state: any): boolean

        • Parameters

          • state: any

          Returns boolean

    • set: (state: any, ...args: any[]) => any
        • (state: any, ...args: any[]): any

        • Parameters

          • state: any
          • Rest ...args: any[]

          Returns any

Variables

Const config

config: { freeze?: <S>(state: S) => Readonly<S> | S }

global configuration

Type declaration

  • Optional freeze?: <S>(state: S) => Readonly<S> | S

    consider activate in development to ensure you're not mutating the state outside of your StateMachines.

    Example

     
    import { config } from '@ezy/makina'

config.freeze = process.env.NODE_ENV !== 'production'? require('deep-freeze-strict') : null;
      • <S>(state: S): Readonly<S> | S

      • Type parameters

        • S

        Parameters

        • state: S

        Returns Readonly<S> | S

Functions

createBase

  • createBase<S>(spec?: S): keyof S extends never ? Merge<Values<GlobalPlugins<S>>> : Merge<Values<GlobalPlugins<S> & SpecBasedPlugins<S>>>

  • create a state machine base class to be extended

    Type parameters

    • S: Spec

    Parameters

    • Default value spec: S = {} as any

    Returns keyof S extends never ? Merge<Values<GlobalPlugins<S>>> : Merge<Values<GlobalPlugins<S> & SpecBasedPlugins<S>>>

install

  • install<K>(plugin: { decoratorFactory: Plugins<any>[K]; name: K }): void

  • Type parameters

    Parameters

    • plugin: { decoratorFactory: Plugins<any>[K]; name: K }
      • decoratorFactory: Plugins<any>[K]
      • name: K

    Returns void

lensFilter

  • lensFilter<A>(predicate: (a: A) => boolean): Lens<A[], A[]>

  • Type parameters

    • A

    Parameters

    • predicate: (a: A) => boolean
        • (a: A): boolean

        • Parameters

          • a: A

          Returns boolean

    Returns Lens<A[], A[]>

lensFind

  • lensFind<A>(predicate: (a: A) => boolean): Lens<A[], A>

  • Type parameters

    • A

    Parameters

    • predicate: (a: A) => boolean
        • (a: A): boolean

        • Parameters

          • a: A

          Returns boolean

    Returns Lens<A[], A>

lensSort

  • lensSort<A>(compareFunction?: (a: A, b: A) => number): Lens<A[], A[]>

  • Type parameters

    • A

    Parameters

    • Default value compareFunction: (a: A, b: A) => number = (a, b) =>a > b ? 1 : a < b ? -1 : 0
        • (a: A, b: A): number

        • Parameters

          • a: A
          • b: A

          Returns number

    Returns Lens<A[], A[]>

lensToSplitLens

set

  • set<S, A>(lens: Lens<S, A>, val: A, obj: S): S

  • Type parameters

    • S

    • A

    Parameters

    • lens: Lens<S, A>
    • val: A
    • obj: S

    Returns S

splitLensProp

  • splitLensProp<S, K>(name: K): SplitLens<S, S[K]>

view

  • view<S, A>(lens: Lens<S, A>, obj: S): A

Generated using TypeDoc