@universal-packages/workflows-terminal-presenter
v1.7.3
Published
Universal workflows terminal presenter
Downloads
66,481
Readme
Workflows Terminal Presenter
Universal workflows terminal presenter.
Install
npm install @universal-packages/workflows-terminal-presenter
npm install @universal-packages/workflows
npm install @universal-packages/terminal-presenter
WorkflowTerminalPresenter
The presenter makes use of a TerminalPresenter to show a graph of the status of a workflow. You can either pass an instance of a TerminalPresenter
or let the WorkflowTerminalPresenter
create one for you.
import { Workflow } from '@universal-packages/workflows'
import { WorkflowTerminalPresenter } from '@universal-packages/workflows-terminal-presenter'
const workflow = Workflow.buildFrom('fast-sleep-good')
const workflowTerminalPresenter = new WorkflowTerminalPresenter({ workflow })
workflowTerminalPresenter.present()
await workflow.run()
Options
logger
Logger
A logger instance to use to visualize workflow events.showRoutines
'always' | 'pending' | 'running'
default: 'always'
Show routines in the graph,always
will always show them,pending
will show them when they are not done,running
will show them when they are running.showRoutineSteps
'always' | 'routine-active' | 'pending' | 'running'
default: 'always'
Show routine steps in the graph,always
will always show them,routine-active
will show them when the routine is active,pending
will show them when they are not done,running
will show them when they are running.showStrategyRoutines
'always' | 'strategy-active' | 'pending' | 'running'
default: 'always'
Show strategy routines in the graph,always
will always show them,strategy-active
will show them when the strategy is active,pending
will show them when they are not done,running
will show them when they are running.TerminalPresenter
TerminalPresenter
The terminal presenter to use to present the graph.workflow
Workflow
The required workflow to present.
Typescript
This library is developed in TypeScript and shipped fully typed.
Contributing
The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.