Class UsageJsonFormatter

Hierarchy (View Summary)

Formatter
- UsageJsonFormatter

Index

Constructors

Properties

colorFns cwd eventDataCollector log printAttachments snippetBuilder stream supportCodeLibrary documentation

Methods

finished logUsage replacer

Constructors

constructor

new UsageJsonFormatter(options: IFormatterOptions): UsageJsonFormatter
Parameters
- options: IFormatterOptions
Returns UsageJsonFormatter
Overrides Formatter.constructor
- Defined in formatter/usage_json_formatter.ts:11

Properties

`Protected`colorFns

colorFns: IColorFns

`Protected`cwd

cwd: string

`Protected`eventDataCollector

eventDataCollector: EventDataCollector

`Protected`log

log: IFormatterLogFn

`Protected`printAttachments

printAttachments: boolean

`Protected`snippetBuilder

snippetBuilder: StepDefinitionSnippetBuilder

`Protected`stream

stream: Writable

`Protected`supportCodeLibrary

supportCodeLibrary: SupportCodeLibrary

`Static` `Readonly`documentation

documentation: string = 'Does what the Usage Formatter does, but outputs JSON, which can be output to a file and then consumed by other tools.'

Methods

finished

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

logUsage

logUsage(): void
Returns void
- Defined in formatter/usage_json_formatter.ts:20

replacer

replacer(key: string, value: any): any
Parameters
- key: string
- value: any
Returns any
- Defined in formatter/usage_json_formatter.ts:28