Class ZHelpFormatter

Options help printer used by default.

Hierarchy

ZHelpFormatter

Index

Constructors

Methods

help textPadding usagePadding usageWidth

Constructors

constructor

new ZHelpFormatter(): ZHelpFormatter
Returns ZHelpFormatter

Methods

help

help(options): Promise<string>
Formats options help information.
Parameters
- options: List
  
  A list of options meta to display.
Returns Promise<string>
A promise resolved to formatted help text.
- Defined in run-z/optionz/src/help/help-formatter.ts:49

textPadding

textPadding(): readonly [number, number, number, number]
Paddings for text column.

Returns readonly [number, number, number, number]
top, right, bottom, and left paddings.
- Defined in run-z/optionz/src/help/help-formatter.ts:37

usagePadding

usagePadding(): readonly [number, number, number, number]
Paddings for usage column.

Returns readonly [number, number, number, number]
top, right, bottom, and left paddings.
- Defined in run-z/optionz/src/help/help-formatter.ts:28

usageWidth

usageWidth(options): number
Detects usage column width.
Parameters
- options: List
  
  A list of options meta to format.
Returns number
- Defined in run-z/optionz/src/help/help-formatter.ts:17

Generated using TypeDoc