Teleforge API Reference - v0.1.0
Preparing search index...
web/src
CoordinationProviderProps
Interface CoordinationProviderProps
interface
CoordinationProviderProps
{
children
:
ReactNode
;
currentRoute
?:
string
|
null
;
config
?:
ResolvedCoordinationConfig
;
flowSnapshot
?:
Record
<
string
,
unknown
>
;
manifest
?:
TeleforgeManifest
;
navigate
?:
(
route
:
string
,
options
?:
{
replace
?:
boolean
}
)
=>
void
;
persistFlowState
?:
(
input
:
PersistFlowStateInput
,
)
=>
UserFlowState
|
Promise
<
UserFlowState
|
null
>
|
null
;
resolveRouteCoordination
?:
(
route
:
string
,
manifest
:
TeleforgeManifest
|
null
,
)
=>
RouteCoordinationMetadata
|
null
;
resolveStepRoute
?:
(
stepId
:
string
,
state
:
UserFlowState
|
null
,
)
=>
string
|
null
;
resolveStepState
?:
(
route
:
string
,
state
:
UserFlowState
|
null
,
)
=>
string
|
null
;
indicatorDurationMs
?:
number
;
onFreshStart
?:
(
reason
:
ResumeFlowError
|
null
)
=>
void
;
onResume
?:
(
result
:
ResumeFlowSuccess
)
=>
void
;
parseFlowId
?:
()
=>
string
|
null
;
resolveRoute
?:
(
state
:
UserFlowState
)
=>
string
|
null
;
resolver
:
FlowStateResolver
;
}
Hierarchy (
View Summary
)
FlowResumeProviderProps
CoordinationProviderProps
Index
Properties
children
current
Route?
config?
flow
Snapshot?
manifest?
navigate?
persist
Flow
State?
resolve
Route
Coordination?
resolve
Step
Route?
resolve
Step
State?
indicator
Duration
Ms?
on
Fresh
Start?
on
Resume?
parse
Flow
Id?
resolve
Route?
resolver
Properties
children
children
:
ReactNode
Optional
current
Route
currentRoute
?:
string
|
null
Optional
config
config
?:
ResolvedCoordinationConfig
Optional
flow
Snapshot
flowSnapshot
?:
Record
<
string
,
unknown
>
Optional
manifest
manifest
?:
TeleforgeManifest
Optional
navigate
navigate
?:
(
route
:
string
,
options
?:
{
replace
?:
boolean
}
)
=>
void
Optional
persist
Flow
State
persistFlowState
?:
(
input
:
PersistFlowStateInput
,
)
=>
UserFlowState
|
Promise
<
UserFlowState
|
null
>
|
null
Optional
resolve
Route
Coordination
resolveRouteCoordination
?:
(
route
:
string
,
manifest
:
TeleforgeManifest
|
null
,
)
=>
RouteCoordinationMetadata
|
null
Optional
resolve
Step
Route
resolveStepRoute
?:
(
stepId
:
string
,
state
:
UserFlowState
|
null
,
)
=>
string
|
null
Optional
resolve
Step
State
resolveStepState
?:
(
route
:
string
,
state
:
UserFlowState
|
null
)
=>
string
|
null
Optional
indicator
Duration
Ms
indicatorDurationMs
?:
number
Optional
on
Fresh
Start
onFreshStart
?:
(
reason
:
ResumeFlowError
|
null
)
=>
void
Optional
on
Resume
onResume
?:
(
result
:
ResumeFlowSuccess
)
=>
void
Optional
parse
Flow
Id
parseFlowId
?:
()
=>
string
|
null
Optional
resolve
Route
resolveRoute
?:
(
state
:
UserFlowState
)
=>
string
|
null
resolver
resolver
:
FlowStateResolver
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
On This Page
Properties
children
current
Route
config
flow
Snapshot
manifest
navigate
persist
Flow
State
resolve
Route
Coordination
resolve
Step
Route
resolve
Step
State
indicator
Duration
Ms
on
Fresh
Start
on
Resume
parse
Flow
Id
resolve
Route
resolver
Teleforge API Reference - v0.1.0
Loading...