@logixjs/react
    Preparing search index...

    Function useModule

    • Type Parameters

      • Id extends string
      • Sh extends AnyModuleShape
      • R = never

      Parameters

      • handle: ModuleImpl<Id, Sh, R>

      Returns ModuleRef<
          StateOf<Sh>,
          ActionOf<Sh>,
          keyof Sh["actionMap"] & string,
          ModuleTag<Id, Sh>,
          ModuleDispatchersOfShape<Sh>,
      >

    • Type Parameters

      • Id extends string
      • Sh extends AnyModuleShape
      • R = never

      Parameters

      • handle: ModuleImpl<Id, Sh, R>
      • options: ModuleImplOptions

      Returns ModuleRef<
          StateOf<Sh>,
          ActionOf<Sh>,
          keyof Sh["actionMap"] & string,
          ModuleTag<Id, Sh>,
          ModuleDispatchersOfShape<Sh>,
      >

    • Type Parameters

      • Id extends string
      • Sh extends AnyModuleShape
      • Ext extends object
      • R = never

      Parameters

      Returns ModuleRef<
          StateOf<Sh>,
          ActionOf<Sh>,
          keyof Sh["actionMap"] & string,
          Module<Id, Sh, Ext, R>,
          ModuleDispatchers<
              ActionOf<Sh>,
              keyof Sh["actionMap"] & string,
              Module<Id, Sh, Ext, R>,
          >,
      > & Ext

    • Type Parameters

      • Id extends string
      • Sh extends AnyModuleShape
      • Ext extends object
      • R = never

      Parameters

      • handle: Module<Id, Sh, Ext, R>
      • options: ModuleImplOptions

      Returns ModuleRef<
          StateOf<Sh>,
          ActionOf<Sh>,
          keyof Sh["actionMap"] & string,
          Module<Id, Sh, Ext, R>,
          ModuleDispatchers<
              ActionOf<Sh>,
              keyof Sh["actionMap"] & string,
              Module<Id, Sh, Ext, R>,
          >,
      > & Ext

    • Type Parameters

      • Id extends string
      • Sh extends AnyModuleShape
      • Ext extends object = {}

      Parameters

      Returns ModuleRef<
          StateOf<Sh>,
          ActionOf<Sh>,
          keyof Sh["actionMap"] & string,
          ModuleDef<Id, Sh, Ext>,
          ModuleDispatchers<
              ActionOf<Sh>,
              keyof Sh["actionMap"] & string,
              ModuleDef<Id, Sh, Ext>,
          >,
      > & Ext

    • Type Parameters

      • Id extends string
      • Sh extends AnyModuleShape

      Parameters

      • handle: ModuleTag<Id, Sh>

      Returns ModuleRef<
          StateOf<Sh>,
          ActionOf<Sh>,
          keyof Sh["actionMap"] & string,
          ModuleTag<Id, Sh>,
          ModuleDispatchersOfShape<Sh>,
      >

    • Type Parameters

      • H extends ReactModuleHandle

      Parameters

      • handle: H

      Returns ModuleRef<StateOfHandle<H>, ActionOfHandle<H>>

    • Type Parameters

      • Id extends string
      • Sh extends AnyModuleShape
      • R
      • V

      Parameters

      • handle: ModuleImpl<Id, Sh, R>
      • selector: (state: StateOf<Sh>) => V
      • OptionalequalityFn: (previous: V, next: V) => boolean

      Returns V

    • Type Parameters

      • Id extends string
      • Sh extends AnyModuleShape
      • R
      • V

      Parameters

      • handle: Module<Id, Sh, any, R>
      • selector: (state: StateOf<Sh>) => V
      • OptionalequalityFn: (previous: V, next: V) => boolean

      Returns V

    • Type Parameters

      • Id extends string
      • Sh extends AnyModuleShape
      • V

      Parameters

      • handle: ModuleDef<Id, Sh, any>
      • selector: (state: StateOf<Sh>) => V
      • OptionalequalityFn: (previous: V, next: V) => boolean

      Returns V

    • Type Parameters

      • Id extends string
      • Sh extends AnyModuleShape
      • V

      Parameters

      • handle: ModuleTag<Id, Sh>
      • selector: (state: StateOf<Sh>) => V
      • OptionalequalityFn: (previous: V, next: V) => boolean

      Returns V

    • Type Parameters

      • H extends ReactModuleHandle
      • V

      Parameters

      • handle: H
      • selector: (state: StateOfHandle<H>) => V
      • OptionalequalityFn: (previous: V, next: V) => boolean

      Returns V