@bluelibs/runner - v5.5.0
Preparing search index...
HookOverrideBuilder
Interface HookOverrideBuilder<TDeps, TOn, TMeta>
interface
HookOverrideBuilder
<
TDeps
extends
DependencyMapType
,
TOn
extends
HookOn
,
TMeta
extends
ITaskMeta
,
>
{
id
:
string
;
build
()
:
IHook
<
TDeps
,
TOn
,
TMeta
>
;
dependencies
<
TNewDeps
extends
DependencyMapType
,
TIsOverride
extends
boolean
=
false
,
>
(
deps
:
TNewDeps
|
(
()
=>
TNewDeps
)
,
options
?:
{
override
?:
TIsOverride
}
,
)
:
HookOverrideBuilder
<
TIsOverride
extends
true
?
TNewDeps
:
TDeps
&
TNewDeps
,
TOn
,
TMeta
,
>
;
meta
<
TNewMeta
extends
ITaskMeta
>
(
m
:
TNewMeta
,
)
:
HookOverrideBuilder
<
TDeps
,
TOn
,
TNewMeta
>
;
order
(
order
:
number
)
:
HookOverrideBuilder
<
TDeps
,
TOn
,
TMeta
>
;
run
(
fn
:
(
event
:
IEventEmission
<
TOn
extends
"*"
?
any
:
TOn
extends
readonly
IEventDefinition
<
any
>
[]
?
CommonPayload
<
TOn
>
:
ExtractEventPayload
<
TOn
>
,
>
,
dependencies
:
DependencyValuesType
<
TDependencies
>
,
)
=>
Promise
<
any
>
,
)
:
HookOverrideBuilder
<
TDeps
,
TOn
,
TMeta
>
;
tags
<
TNewTags
extends
TagType
[]
>
(
t
:
TNewTags
,
options
?:
{
override
?:
boolean
}
,
)
:
HookOverrideBuilder
<
TDeps
,
TOn
,
TMeta
>
;
throws
(
list
:
ThrowsList
)
:
HookOverrideBuilder
<
TDeps
,
TOn
,
TMeta
>
;
}
Type Parameters
TDeps
extends
DependencyMapType
TOn
extends
HookOn
TMeta
extends
ITaskMeta
Index
Properties
id
Methods
build
dependencies
meta
order
run
tags
throws
Properties
id
id
:
string
Methods
build
build
()
:
IHook
<
TDeps
,
TOn
,
TMeta
>
Returns
IHook
<
TDeps
,
TOn
,
TMeta
>
dependencies
dependencies
<
TNewDeps
extends
DependencyMapType
,
TIsOverride
extends
boolean
=
false
,
>
(
deps
:
TNewDeps
|
(
()
=>
TNewDeps
)
,
options
?:
{
override
?:
TIsOverride
}
,
)
:
HookOverrideBuilder
<
TIsOverride
extends
true
?
TNewDeps
:
TDeps
&
TNewDeps
,
TOn
,
TMeta
,
>
Type Parameters
TNewDeps
extends
DependencyMapType
TIsOverride
extends
boolean
=
false
Parameters
deps
:
TNewDeps
|
(
()
=>
TNewDeps
)
Optional
options
:
{
override
?:
TIsOverride
}
Returns
HookOverrideBuilder
<
TIsOverride
extends
true
?
TNewDeps
:
TDeps
&
TNewDeps
,
TOn
,
TMeta
,
>
meta
meta
<
TNewMeta
extends
ITaskMeta
>
(
m
:
TNewMeta
,
)
:
HookOverrideBuilder
<
TDeps
,
TOn
,
TNewMeta
>
Type Parameters
TNewMeta
extends
ITaskMeta
Parameters
m
:
TNewMeta
Returns
HookOverrideBuilder
<
TDeps
,
TOn
,
TNewMeta
>
order
order
(
order
:
number
)
:
HookOverrideBuilder
<
TDeps
,
TOn
,
TMeta
>
Parameters
order
:
number
Returns
HookOverrideBuilder
<
TDeps
,
TOn
,
TMeta
>
run
run
(
fn
:
(
event
:
IEventEmission
<
TOn
extends
"*"
?
any
:
TOn
extends
readonly
IEventDefinition
<
any
>
[]
?
CommonPayload
<
TOn
>
:
ExtractEventPayload
<
TOn
>
,
>
,
dependencies
:
DependencyValuesType
<
TDependencies
>
,
)
=>
Promise
<
any
>
,
)
:
HookOverrideBuilder
<
TDeps
,
TOn
,
TMeta
>
Parameters
fn
:
(
event
:
IEventEmission
<
TOn
extends
"*"
?
any
:
TOn
extends
readonly
IEventDefinition
<
any
>
[]
?
CommonPayload
<
TOn
>
:
ExtractEventPayload
<
TOn
>
,
>
,
dependencies
:
DependencyValuesType
<
TDependencies
>
,
)
=>
Promise
<
any
>
Returns
HookOverrideBuilder
<
TDeps
,
TOn
,
TMeta
>
tags
tags
<
TNewTags
extends
TagType
[]
>
(
t
:
TNewTags
,
options
?:
{
override
?:
boolean
}
,
)
:
HookOverrideBuilder
<
TDeps
,
TOn
,
TMeta
>
Type Parameters
TNewTags
extends
TagType
[]
Parameters
t
:
TNewTags
Optional
options
:
{
override
?:
boolean
}
Returns
HookOverrideBuilder
<
TDeps
,
TOn
,
TMeta
>
throws
throws
(
list
:
ThrowsList
)
:
HookOverrideBuilder
<
TDeps
,
TOn
,
TMeta
>
Declare which typed errors this hook may throw (declarative only).
Parameters
list
:
ThrowsList
Returns
HookOverrideBuilder
<
TDeps
,
TOn
,
TMeta
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
id
Methods
build
dependencies
meta
order
run
tags
throws
@bluelibs/runner - v5.5.0
Loading...
Declare which typed errors this hook may throw (declarative only).