@bluelibs/runner - v5.5.0
Preparing search index...
PhantomTaskFluentBuilder
Interface PhantomTaskFluentBuilder<TInput, TResolved, TDeps, TMeta, TTags, TMiddleware>
Fluent builder interface for constructing phantom tasks.
interface
PhantomTaskFluentBuilder
<
TInput
=
undefined
,
TResolved
=
any
,
TDeps
extends
DependencyMapType
=
{}
,
TMeta
extends
ITaskMeta
=
ITaskMeta
,
TTags
extends
TagType
[]
=
TagType
[]
,
TMiddleware
extends
TaskMiddlewareAttachmentType
[]
=
TaskMiddlewareAttachmentType
[]
,
>
{
id
:
string
;
build
()
:
IPhantomTask
<
TInput
,
TResolved
,
TDeps
,
TMeta
,
TTags
,
TMiddleware
>
;
dependencies
<
TNewDeps
extends
DependencyMapType
>
(
deps
:
TNewDeps
|
(
()
=>
TNewDeps
)
,
options
?:
{
override
?:
false
}
,
)
:
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
&
TNewDeps
,
TMeta
,
TTags
,
TMiddleware
,
>
;
dependencies
<
TNewDeps
extends
DependencyMapType
>
(
deps
:
TNewDeps
|
(
()
=>
TNewDeps
)
,
options
:
{
override
:
true
}
,
)
:
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TNewDeps
,
TMeta
,
TTags
,
TMiddleware
,
>
;
inputSchema
<
TNewInput
>
(
schema
:
IValidationSchema
<
TNewInput
>
,
)
:
PhantomTaskFluentBuilder
<
TNewInput
,
TResolved
,
TDeps
,
TMeta
,
TTags
,
TMiddleware
,
>
;
meta
<
TNewMeta
extends
ITaskMeta
>
(
m
:
TNewMeta
,
)
:
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
,
TNewMeta
,
TTags
,
TMiddleware
,
>
;
middleware
<
TNewMw
extends
TaskMiddlewareAttachmentType
[]
>
(
mw
:
TNewMw
,
options
?:
{
override
?:
boolean
}
,
)
:
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
,
TMeta
,
TTags
,
TNewMw
>
;
resultSchema
<
TNewResolved
>
(
schema
:
IValidationSchema
<
TNewResolved
>
,
)
:
PhantomTaskFluentBuilder
<
TInput
,
TNewResolved
,
TDeps
,
TMeta
,
TTags
,
TMiddleware
,
>
;
tags
<
TNewTags
extends
TagType
[]
>
(
t
:
TNewTags
,
options
?:
{
override
?:
false
}
,
)
:
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
,
TMeta
,
[
...
TTags
[]
,
...
TNewTags
[]
]
,
TMiddleware
,
>
;
tags
<
TNewTags
extends
TagType
[]
>
(
t
:
TNewTags
,
options
:
{
override
:
true
}
,
)
:
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
,
TMeta
,
TNewTags
,
TMiddleware
,
>
;
throws
(
list
:
ThrowsList
,
)
:
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
,
TMeta
,
TTags
,
TMiddleware
,
>
;
}
Type Parameters
TInput
=
undefined
TResolved
=
any
TDeps
extends
DependencyMapType
=
{}
TMeta
extends
ITaskMeta
=
ITaskMeta
TTags
extends
TagType
[]
=
TagType
[]
TMiddleware
extends
TaskMiddlewareAttachmentType
[]
=
TaskMiddlewareAttachmentType
[]
Index
Properties
id
Methods
build
dependencies
input
Schema
meta
middleware
result
Schema
tags
throws
Properties
id
id
:
string
Methods
build
build
()
:
IPhantomTask
<
TInput
,
TResolved
,
TDeps
,
TMeta
,
TTags
,
TMiddleware
>
Returns
IPhantomTask
<
TInput
,
TResolved
,
TDeps
,
TMeta
,
TTags
,
TMiddleware
>
dependencies
dependencies
<
TNewDeps
extends
DependencyMapType
>
(
deps
:
TNewDeps
|
(
()
=>
TNewDeps
)
,
options
?:
{
override
?:
false
}
,
)
:
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
&
TNewDeps
,
TMeta
,
TTags
,
TMiddleware
,
>
Type Parameters
TNewDeps
extends
DependencyMapType
Parameters
deps
:
TNewDeps
|
(
()
=>
TNewDeps
)
Optional
options
:
{
override
?:
false
}
Returns
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
&
TNewDeps
,
TMeta
,
TTags
,
TMiddleware
,
>
dependencies
<
TNewDeps
extends
DependencyMapType
>
(
deps
:
TNewDeps
|
(
()
=>
TNewDeps
)
,
options
:
{
override
:
true
}
,
)
:
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TNewDeps
,
TMeta
,
TTags
,
TMiddleware
,
>
Type Parameters
TNewDeps
extends
DependencyMapType
Parameters
deps
:
TNewDeps
|
(
()
=>
TNewDeps
)
options
:
{
override
:
true
}
Returns
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TNewDeps
,
TMeta
,
TTags
,
TMiddleware
>
input
Schema
inputSchema
<
TNewInput
>
(
schema
:
IValidationSchema
<
TNewInput
>
,
)
:
PhantomTaskFluentBuilder
<
TNewInput
,
TResolved
,
TDeps
,
TMeta
,
TTags
,
TMiddleware
,
>
Type Parameters
TNewInput
Parameters
schema
:
IValidationSchema
<
TNewInput
>
Returns
PhantomTaskFluentBuilder
<
TNewInput
,
TResolved
,
TDeps
,
TMeta
,
TTags
,
TMiddleware
>
meta
meta
<
TNewMeta
extends
ITaskMeta
>
(
m
:
TNewMeta
,
)
:
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
,
TNewMeta
,
TTags
,
TMiddleware
,
>
Type Parameters
TNewMeta
extends
ITaskMeta
Parameters
m
:
TNewMeta
Returns
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
,
TNewMeta
,
TTags
,
TMiddleware
>
middleware
middleware
<
TNewMw
extends
TaskMiddlewareAttachmentType
[]
>
(
mw
:
TNewMw
,
options
?:
{
override
?:
boolean
}
,
)
:
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
,
TMeta
,
TTags
,
TNewMw
>
Type Parameters
TNewMw
extends
TaskMiddlewareAttachmentType
[]
Parameters
mw
:
TNewMw
Optional
options
:
{
override
?:
boolean
}
Returns
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
,
TMeta
,
TTags
,
TNewMw
>
result
Schema
resultSchema
<
TNewResolved
>
(
schema
:
IValidationSchema
<
TNewResolved
>
,
)
:
PhantomTaskFluentBuilder
<
TInput
,
TNewResolved
,
TDeps
,
TMeta
,
TTags
,
TMiddleware
,
>
Type Parameters
TNewResolved
Parameters
schema
:
IValidationSchema
<
TNewResolved
>
Returns
PhantomTaskFluentBuilder
<
TInput
,
TNewResolved
,
TDeps
,
TMeta
,
TTags
,
TMiddleware
>
tags
tags
<
TNewTags
extends
TagType
[]
>
(
t
:
TNewTags
,
options
?:
{
override
?:
false
}
,
)
:
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
,
TMeta
,
[
...
TTags
[]
,
...
TNewTags
[]
]
,
TMiddleware
,
>
Type Parameters
TNewTags
extends
TagType
[]
Parameters
t
:
TNewTags
Optional
options
:
{
override
?:
false
}
Returns
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
,
TMeta
,
[
...
TTags
[]
,
...
TNewTags
[]
]
,
TMiddleware
,
>
tags
<
TNewTags
extends
TagType
[]
>
(
t
:
TNewTags
,
options
:
{
override
:
true
}
,
)
:
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
,
TMeta
,
TNewTags
,
TMiddleware
,
>
Type Parameters
TNewTags
extends
TagType
[]
Parameters
t
:
TNewTags
options
:
{
override
:
true
}
Returns
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
,
TMeta
,
TNewTags
,
TMiddleware
>
throws
throws
(
list
:
ThrowsList
,
)
:
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
,
TMeta
,
TTags
,
TMiddleware
,
>
Parameters
list
:
ThrowsList
Returns
PhantomTaskFluentBuilder
<
TInput
,
TResolved
,
TDeps
,
TMeta
,
TTags
,
TMiddleware
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
id
Methods
build
dependencies
input
Schema
meta
middleware
result
Schema
tags
throws
@bluelibs/runner - v5.5.0
Loading...
Fluent builder interface for constructing phantom tasks.