Skip to content
sfn-diagram
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Getting started
Introduction
Comparison
Installation
Quick start
Guides
Command line
Configuration
Examples
Use with your framework
Gallery
Use from Python, Go, Java, and other languages
Runtime support
Supported state types
TypeScript
API Reference
aws
Interfaces
FetchExecutionHistoryParams
Functions
fetchExecutionHistory
cfn
Interfaces
ExtractAslFromTemplateParams
ExtractAslResult
Functions
extractAslFromTemplate
ci
Interfaces
AslFileChange
AslFileSection
AssembleCommentBodyParams
BuildAslFileSectionOptions
BuildExecutionOverlaySectionParams
BuildExecutionOverlaySectionResult
ChangedAslFile
ExecutionOverlaySection
FetchExecutionForOverlayParams
GetChangedAslFilesParams
GitlabMergeRequestContext
OverlayCandidate
OverlayExecution
RenderAslFileSectionOptions
RenderExecutionOverlaySectionOptions
RunGitlabCommentParams
RunGitlabCommentResult
UpsertMergeRequestNoteParams
UpsertMergeRequestNoteResult
Type Aliases
ExecutionMode
Variables
DEFAULT_DIAGRAM_OMISSION_NOTE
DEFAULT_EXECUTION_DIAGRAM_OMISSION_NOTE
DEFAULT_REPORT_FOOTER
DEFAULT_REPORT_HEADING
LINT_ERROR_DIAGRAM_NOTE
MAX_INLINE_MERMAID_CHARS
Functions
assembleCommentBody
buildAslFileSection
buildExecutionOverlaySection
buildLintSection
detectGitlabMergeRequestContext
fetchExecutionForOverlay
formatStateList
getChangedAslFiles
isAslDefinition
matchesPatterns
parseAslJson
readFileAtGitRef
readWorkingTreeFile
renderAslFileSection
renderExecutionOverlaySection
resolveGitlabToken
runGitlabComment
upsertMergeRequestNote
element
Classes
SfnDiagramElement
Interfaces
DefineSfnDiagramParams
Functions
defineSfnDiagram
index
Classes
AslSyntaxError
AslValidationError
SfnDiagramGenerator
Interfaces
AslDefinition
AslState
BuildExecutionTimelineParams
CustomTheme
DiagramOptions
DiffOutput
DiffStateSummary
EdgeStyleOverride
ExecutionHtmlOutput
ExecutionOutput
ExecutionOverlay
ExecutionStateResult
ExecutionSummary
ExecutionTimeline
GenerateDiagramParams
GenerateDiffParams
GenerateExecutionHtmlParams
GenerateExecutionParams
GenerateFromAwsParams
GenerateHtmlParams
GenerateMermaidDiffParams
GenerateMermaidExecutionParams
GenerateMermaidParams
GenerateSvgParams
GenerateViewerUpdateParams
GraphEdge
HtmlDiffOverlay
HtmlOutput
LintAslParams
LintDiagnostic
MermaidDiffOutput
MermaidExecutionOutput
MermaidOutput
NodeStyle
ResolvedTheme
StateNode
SvgOutput
TakenEdge
TimelineEntry
TimelinePayload
ViewerUpdate
Type Aliases
CatchHandling
DiagramFormat
DiffStatus
EdgePathStyle
EdgeType
ExecutionHistoryInput
ExecutionStateStatus
ExecutionStatus
LayoutDirection
LintCode
LintSeverity
NodeShape
QueryLanguage
StateType
ThemeOption
TimelineEntryStatus
ViewerTheme
Variables
AWS_DARK_THEME
AWS_LIGHT_THEME
EXECUTION_PAYLOAD_CAP
EXECUTION_PAYLOAD_TOTAL_CAP
Functions
buildExecutionTimeline
buildViewerContent
embedIcons
generateDiagram
generateDiff
generateExecution
generateExecutionHtml
generateExecutionHtmlAsync
generateFromAwsResponse
generateHtml
generateHtmlAsync
generateMermaid
generateMermaidDiff
generateMermaidExecution
generateSvg
generateViewerUpdate
lintAsl
parseExecutionHistory
resolveViewerTheme
validateAsl
png
Classes
PngExporter
Interfaces
ExportPngParams
PngOutput
Functions
exportPng
Ecosystem
GitHub Action
GitLab CI
Playground
React component
VS Code extension
Web component
GitHub
Select theme
Dark
Light
Auto
DEFAULT_REPORT_FOOTER
Copy Markdown
Open
Open in ChatGPT
Open in Claude
Open in Cursor
Open in GitHub Copilot
View in Markdown
const
DEFAULT_REPORT_FOOTER
:
string
;
Defined in:
src/ci/buildReport.ts:437