Namespace: pc
January 18, 2022 · View on GitHub
Kui API Documentation - v11.0.0 / @kui-shell/core / pc
Namespace: pc
Table of contents
Functions
Functions
command
▸ command(cmdline): string
Parameters
| Name | Type |
|---|---|
cmdline | string |
Returns
string
Defined in
packages/core/src/core/usage/pretty-code.ts:23
examples
▸ examples(examples, sectionTitle?): string
Parameters
| Name | Type | Default value |
|---|---|---|
examples | Example[] | undefined |
sectionTitle | string | 'Examples' |
Returns
string
Defined in
packages/core/src/core/usage/pretty-code.ts:70
intro
▸ intro(paragraph): string
Parameters
| Name | Type |
|---|---|
paragraph | string |
Returns
string
Defined in
packages/core/src/core/usage/pretty-code.ts:27
option
▸ option(opts): string
Parameters
| Name | Type |
|---|---|
opts | string | string[] |
Returns
string
Defined in
packages/core/src/core/usage/pretty-code.ts:31
options
▸ options(options): string
Parameters
| Name | Type |
|---|---|
options | Option[] |
Returns
string
Defined in
packages/core/src/core/usage/pretty-code.ts:87
pipeline
▸ pipeline(code): string
Parameters
| Name | Type |
|---|---|
code | string |
Returns
string
pretty-printed version of the given bash pipeline
Defined in
packages/core/src/core/usage/pretty-code.ts:43
related
▸ related(related): string
Parameters
| Name | Type |
|---|---|
related | string[] |
Returns
string
Defined in
packages/core/src/core/usage/pretty-code.ts:81
title
▸ title(_): string
Parameters
| Name | Type |
|---|---|
_ | Title |
Returns
string
Defined in
packages/core/src/core/usage/pretty-code.ts:37
usage
▸ usage(usages): string
Parameters
| Name | Type |
|---|---|
usages | string[] |
Returns
string