Sanity Library Reference Docs
Preparing search index...
@sanity/workflow-engine
index
AuthoringWorkflow
Interface AuthoringWorkflow
The authoring surface: stored primitives plus the define-time sugar.
interface
AuthoringWorkflow
{
description
?:
string
;
fields
?:
AuthoringFieldEntry
[]
;
groups
?:
Group
[]
;
initialStage
:
string
;
lifecycle
?:
WorkflowLifecycle
;
name
:
string
;
predicates
?:
Record
<
string
,
string
>
;
roleAliases
?:
RoleAliases
;
semantics
?:
Semantic
[]
;
stages
:
AuthoringStage
[]
;
start
?:
AuthoringStartBlock
;
title
:
string
;
}
Index
Properties
description?
fields?
groups?
initial
Stage
lifecycle?
name
predicates?
role
Aliases?
semantics?
stages
start?
title
Properties
Optional
description
description
?:
string
Optional
fields
fields
?:
AuthoringFieldEntry
[]
Optional
groups
groups
?:
Group
[]
initial
Stage
initialStage
:
string
Optional
lifecycle
lifecycle
?:
WorkflowLifecycle
name
name
:
string
Optional
predicates
predicates
?:
Record
<
string
,
string
>
Optional
role
Aliases
roleAliases
?:
RoleAliases
Optional
semantics
semantics
?:
Semantic
[]
stages
stages
:
AuthoringStage
[]
Optional
start
start
?:
AuthoringStartBlock
title
title
:
string
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
description
fields
groups
initial
Stage
lifecycle
name
predicates
role
Aliases
semantics
stages
start
title
Sanity Library Reference Docs
Loading...
The authoring surface: stored primitives plus the define-time sugar.