Class SummaryFormatter

Deprecated

the built-in summary formatter is now plugin-based and no longer uses this class; see https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md

Hierarchy (View Summary)

Formatter
- SummaryFormatter
  - ProgressFormatter

Index

Constructors

Properties

colorFns cwd documentation eventDataCollector log printAttachments snippetBuilder stream supportCodeLibrary

Methods

finished logIssues logSummary

Constructors

constructor

new SummaryFormatter(options: IFormatterOptions): SummaryFormatter
Parameters
- options: IFormatterOptions
Returns SummaryFormatter
Overrides Formatter.constructor
- Defined in formatter/summary_formatter.ts:21

Properties

`Protected`colorFns

colorFns: IColorFns

`Protected`cwd

cwd: string

`Static` `Readonly`documentation

documentation: string = 'Summary output of feature and scenarios'

`Protected`eventDataCollector

eventDataCollector: EventDataCollector

`Protected`log

log: IFormatterLogFn

`Protected`printAttachments

printAttachments: boolean

`Protected`snippetBuilder

snippetBuilder: StepDefinitionSnippetBuilder

`Protected`stream

stream: Writable

`Protected`supportCodeLibrary

supportCodeLibrary: SupportCodeLibrary

Methods

finished

finished(): Promise<void>
Returns Promise<void>
Inherited from Formatter.finished
- Defined in formatter/index.ts:88

logIssues

logIssues(__namedParameters: ILogIssuesRequest): void
Parameters
- __namedParameters: ILogIssuesRequest
Returns void
- Defined in formatter/summary_formatter.ts:83

logSummary

logSummary(testRunDuration: Duration): void
Parameters
- testRunDuration: Duration
Returns void
- Defined in formatter/summary_formatter.ts:40