Interface ZColors

Terminal color theme to use for text formatting.

Hierarchy

ZColors

Index

Methods

bullet optional param sign usage

Methods

bullet

bullet(sign?): string
Formats a list bullet.
Parameters
- Optional sign: string
  
  Override bullet symbol to use.
Returns string
Formatted bullet.
- Defined in run-z/optionz/src/colors/colors.ts:51

optional

optional(text): string
Formats optional part of grammar definition.
Parameters
- text: string
  
  Optional grammar text.
Returns string
Formatted optional grammar.
- Defined in run-z/optionz/src/colors/colors.ts:42

param

param(name): string
Formats option parameter placeholder.
Parameters
- name: string
  
  Parameter name.
Returns string
Formatted placeholder.
- Defined in run-z/optionz/src/colors/colors.ts:24

sign

sign(sign): string
Formats a sign to use as part of grammar definition.
Parameters
- sign: string
  
  A sign to format.
Returns string
Formatted sign.
- Defined in run-z/optionz/src/colors/colors.ts:33

usage

usage(text): string
Formats option usage text.
Parameters
- text: string
  
  Original usage text.
Returns string
Formatted usage text.
- Defined in run-z/optionz/src/colors/colors.ts:15

Generated using TypeDoc