Search
Preparing search index...
The search index is not available
@znemz/use-global-hook
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"index"
External module "index"
Index
Interfaces
React
Lib
Store
Use
Store
Props
Type aliases
Associate
Actions
Fn
Hook
Work
Initializer
Set
Ref
Fn
Set
State
Fn
Use
Custom
Fn
Use
Effect
Use
State
Use
Store
Fn
Functions
associate
Actions
set
Ref
set
State
use
Custom
use
Store
Type aliases
Associate
Actions
Fn
Associate
Actions
Fn
:
function
Type declaration
<T, A>
(
store
:
Store
<
T
,
A
>
, actions
:
A
)
:
A
Type parameters
T
A
Parameters
store:
Store
<
T
,
A
>
actions:
A
Returns
A
Hook
Work
Hook
Work<T>
:
function
Type parameters
T
Type declaration
(
)
:
T
Returns
T
Initializer
Initializer<T, A>
:
function
Type parameters
T
A
Type declaration
(
_
:
Store
<
T
,
A
>
)
:
void
Parameters
_:
Store
<
T
,
A
>
Returns
void
Set
Ref
Fn
Set
Ref
Fn<T>
:
function
Type parameters
T
Type declaration
(
newState
:
T
, doDigest
?:
boolean
)
:
void
Parameters
newState:
T
Optional
doDigest:
boolean
Returns
void
Set
State
Fn
Set
State
Fn<T>
:
function
Type parameters
T
Type declaration
(
newState
:
T
, isRef
?:
boolean
, doDigest
?:
boolean
)
:
void
Parameters
newState:
T
Optional
isRef:
boolean
Optional
doDigest:
boolean
Returns
void
Use
Custom
Fn
Use
Custom
Fn
:
function
Type declaration
(
React
:
ReactLib
)
:
void
Parameters
React:
ReactLib
Returns
void
Use
Effect
Use
Effect
:
function
Type declaration
(
effect
:
EffectCallback
, deps
?:
DependencyList
)
:
void
Parameters
effect:
EffectCallback
Optional
deps:
DependencyList
Returns
void
Use
State
Use
State
:
function
Type declaration
<S>
(
initialState
?:
S
|
function
)
:
[
S
,
Dispatch
<
SetStateAction
<
S
>
>
]
Type parameters
S
Parameters
Optional
initialState:
S
|
function
Returns
[
S
,
Dispatch
<
SetStateAction
<
S
>
>
]
Use
Store
Fn
Use
Store
Fn
:
function
Type declaration
<T, InnerA, OuterA, WorkR>
(
_
:
UseStoreProps
<
T
,
InnerA
,
OuterA
,
WorkR
>
)
:
function
Type parameters
T
InnerA
OuterA
WorkR
Parameters
_:
UseStoreProps
<
T
,
InnerA
,
OuterA
,
WorkR
>
Returns
function
(
)
:
[
T
,
OuterA
,
Array
]
Returns
[
T
,
OuterA
,
Array
]
Functions
associate
Actions
associate
Actions<T, InnerA, OuterA>
(
store
:
Store
<
T
,
OuterA
>
, actions
:
InnerA
)
:
OuterA
Type parameters
T
InnerA
OuterA
Parameters
store:
Store
<
T
,
OuterA
>
actions:
InnerA
Returns
OuterA
set
Ref
set
Ref<T, A>
(
this
:
Store
<
T
,
A
>
, newState
:
T
, doDigest
?:
boolean
)
:
void
Type parameters
T
A
Parameters
this:
Store
<
T
,
A
>
newState:
T
Optional
doDigest:
boolean
Returns
void
set
State
set
State<T, A>
(
this
:
Store
<
T
,
A
>
, newState
:
T
, isRef
?:
boolean
, doDigest
?:
boolean
)
:
void
Type parameters
T
A
Parameters
this:
Store
<
T
,
A
>
newState:
T
Optional
isRef:
boolean
Default value
doDigest:
boolean
= true
Returns
void
use
Custom
use
Custom<T, A, WorkR>
(
this
:
Store
<
T
,
A
>
, React
:
ReactLib
, hookWork
?:
HookWork
<
WorkR
>
)
:
[
T
,
A
]
Type parameters
T
A
WorkR
:
WorkR
[]
Parameters
this:
Store
<
T
,
A
>
React:
ReactLib
Optional
hookWork:
HookWork
<
WorkR
>
Returns
[
T
,
A
]
Const
use
Store
use
Store<T, InnerA, OuterA, WorkR>
(
__namedParameters
?:
object
)
:
function
Type parameters
T
InnerA
OuterA
WorkR
Parameters
Default value
__namedParameters:
object
= {} as UseStoreProps<T, InnerA, OuterA, WorkR>
React
:
ReactLib
actions
:
InnerA
|
InnerBaseActions
<
T
>
initial
State
:
T
initializer
:
function
(
_
:
Store
<
T
,
A
>
)
:
void
Parameters
_:
Store
<
T
,
A
>
Returns
void
Returns
function
(
_
?:
HookWork
<
WorkR
>
)
:
[
T
,
OuterA
]
Parameters
Optional
_:
HookWork
<
WorkR
>
Returns
[
T
,
OuterA
]
Globals
"actions"
"index"
React
Lib
Store
Use
Store
Props
Associate
Actions
Fn
Hook
Work
Initializer
Set
Ref
Fn
Set
State
Fn
Use
Custom
Fn
Use
Effect
Use
State
Use
Store
Fn
associate
Actions
set
Ref
set
State
use
Custom
use
Store
Generated using
TypeDoc