Class RunSummaries

Use the RunSummaries construct to set custom summary messages during the execution of actions that will be surfaced on the workflows UI.

Hierarchy

RunSummaries

Index

Constructors

Properties

Methods

addRunSummary addRunSummaryMessage clearRunSummaries truncate

Constructors

constructor

new RunSummaries(): RunSummaries
Returns RunSummaries

Properties

`Static` runSummaries

runSummaries: RunSummaryMessage[] = []

Methods

`Static` addRunSummary

addRunSummary(text: string | Error, summaryLevel: ERROR): void
Parameters
- text: string | Error
- summaryLevel: ERROR
Returns void
- Defined in codecatalyst-entities/run-summaries/lib/run-summaries.ts:15

`Static` addRunSummaryMessage

addRunSummaryMessage(message: Message): void
Parameters
- message: Message
Returns void
- Defined in codecatalyst-entities/run-summaries/lib/run-summaries.ts:25

`Static` clearRunSummaries

clearRunSummaries(): void
Returns void
- Defined in codecatalyst-entities/run-summaries/lib/run-summaries.ts:38

`Static` `Private` truncate

truncate(s: string, length: number): string
Parameters
- s: string
- length: number
Returns string
- Defined in codecatalyst-entities/run-summaries/lib/run-summaries.ts:43

Generated using TypeDoc