@logixjs/react
Preparing search index...
useModule
Function useModule
useModule
<
Id
extends
string
,
Sh
extends
AnyModuleShape
,
R
=
never
>
(
handle
:
ModuleImpl
<
Id
,
Sh
,
R
>
,
)
:
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
>
Returns
ModuleRef
<
StateOf
<
Sh
>
,
ActionOf
<
Sh
>
,
keyof
Sh
[
"actionMap"
]
&
string
,
ModuleTag
<
Id
,
Sh
>
,
ModuleDispatchersOfShape
<
Sh
>
,
>
useModule
<
Id
extends
string
,
Sh
extends
AnyModuleShape
,
R
=
never
>
(
handle
:
ModuleImpl
<
Id
,
Sh
,
R
>
,
options
:
ModuleImplOptions
,
)
:
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
>
,
>
useModule
<
Id
extends
string
,
Sh
extends
AnyModuleShape
,
Ext
extends
object
,
R
=
never
,
>
(
handle
:
Module
<
Id
,
Sh
,
Ext
,
R
>
,
)
:
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
>
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
useModule
<
Id
extends
string
,
Sh
extends
AnyModuleShape
,
Ext
extends
object
,
R
=
never
,
>
(
handle
:
Module
<
Id
,
Sh
,
Ext
,
R
>
,
options
:
ModuleImplOptions
,
)
:
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
useModule
<
Id
extends
string
,
Sh
extends
AnyModuleShape
,
Ext
extends
object
=
{}
>
(
handle
:
ModuleDef
<
Id
,
Sh
,
Ext
>
,
)
:
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
Ext
extends
object
=
{}
Parameters
handle
:
ModuleDef
<
Id
,
Sh
,
Ext
>
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
useModule
<
Id
extends
string
,
Sh
extends
AnyModuleShape
>
(
handle
:
ModuleTag
<
Id
,
Sh
>
,
)
:
ModuleRef
<
StateOf
<
Sh
>
,
ActionOf
<
Sh
>
,
keyof
Sh
[
"actionMap"
]
&
string
,
ModuleTag
<
Id
,
Sh
>
,
ModuleDispatchersOfShape
<
Sh
>
,
>
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
>
,
>
useModule
<
H
extends
ReactModuleHandle
>
(
handle
:
H
,
)
:
ModuleRef
<
StateOfHandle
<
H
>
,
ActionOfHandle
<
H
>
>
Type Parameters
H
extends
ReactModuleHandle
Parameters
handle
:
H
Returns
ModuleRef
<
StateOfHandle
<
H
>
,
ActionOfHandle
<
H
>
>
useModule
<
Id
extends
string
,
Sh
extends
AnyModuleShape
,
R
,
V
>
(
handle
:
ModuleImpl
<
Id
,
Sh
,
R
>
,
selector
:
(
state
:
StateOf
<
Sh
>
)
=>
V
,
equalityFn
?:
(
previous
:
V
,
next
:
V
)
=>
boolean
,
)
:
V
Type Parameters
Id
extends
string
Sh
extends
AnyModuleShape
R
V
Parameters
handle
:
ModuleImpl
<
Id
,
Sh
,
R
>
selector
:
(
state
:
StateOf
<
Sh
>
)
=>
V
Optional
equalityFn
:
(
previous
:
V
,
next
:
V
)
=>
boolean
Returns
V
useModule
<
Id
extends
string
,
Sh
extends
AnyModuleShape
,
R
,
V
>
(
handle
:
Module
<
Id
,
Sh
,
any
,
R
>
,
selector
:
(
state
:
StateOf
<
Sh
>
)
=>
V
,
equalityFn
?:
(
previous
:
V
,
next
:
V
)
=>
boolean
,
)
:
V
Type Parameters
Id
extends
string
Sh
extends
AnyModuleShape
R
V
Parameters
handle
:
Module
<
Id
,
Sh
,
any
,
R
>
selector
:
(
state
:
StateOf
<
Sh
>
)
=>
V
Optional
equalityFn
:
(
previous
:
V
,
next
:
V
)
=>
boolean
Returns
V
useModule
<
Id
extends
string
,
Sh
extends
AnyModuleShape
,
V
>
(
handle
:
ModuleDef
<
Id
,
Sh
,
any
>
,
selector
:
(
state
:
StateOf
<
Sh
>
)
=>
V
,
equalityFn
?:
(
previous
:
V
,
next
:
V
)
=>
boolean
,
)
:
V
Type Parameters
Id
extends
string
Sh
extends
AnyModuleShape
V
Parameters
handle
:
ModuleDef
<
Id
,
Sh
,
any
>
selector
:
(
state
:
StateOf
<
Sh
>
)
=>
V
Optional
equalityFn
:
(
previous
:
V
,
next
:
V
)
=>
boolean
Returns
V
useModule
<
Id
extends
string
,
Sh
extends
AnyModuleShape
,
V
>
(
handle
:
ModuleTag
<
Id
,
Sh
>
,
selector
:
(
state
:
StateOf
<
Sh
>
)
=>
V
,
equalityFn
?:
(
previous
:
V
,
next
:
V
)
=>
boolean
,
)
:
V
Type Parameters
Id
extends
string
Sh
extends
AnyModuleShape
V
Parameters
handle
:
ModuleTag
<
Id
,
Sh
>
selector
:
(
state
:
StateOf
<
Sh
>
)
=>
V
Optional
equalityFn
:
(
previous
:
V
,
next
:
V
)
=>
boolean
Returns
V
useModule
<
H
extends
ReactModuleHandle
,
V
>
(
handle
:
H
,
selector
:
(
state
:
StateOfHandle
<
H
>
)
=>
V
,
equalityFn
?:
(
previous
:
V
,
next
:
V
)
=>
boolean
,
)
:
V
Type Parameters
H
extends
ReactModuleHandle
V
Parameters
handle
:
H
selector
:
(
state
:
StateOfHandle
<
H
>
)
=>
V
Optional
equalityFn
:
(
previous
:
V
,
next
:
V
)
=>
boolean
Returns
V
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
@logixjs/react
Loading...