view
Classes
ViewClass<T>
Defined in: src/cli-sdk/src/view.ts:16
The base class for all View classes
Do not override the constructor, just provide start/done/error methods.
These classes should be used as one or more of the exported views for commands that need to know when the processing starts, handle errors in various ways, etc. Fancy stuff.
For simple use cases, usually better to create a ViewFn instead.
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Constructors
new ViewClass()
new ViewClass<T>(options, config): ViewClass<T>Defined in: src/cli-sdk/src/view.ts:20
Parameters
| Parameter | Type |
|---|---|
options | ViewOptions |
config | ParsedConfig |
Returns
ViewClass<T>
Properties
| Property | Type |
|---|---|
config | ParsedConfig |
options | ViewOptions |
Methods
done()
done(_result, _opts): Promise<unknown>Defined in: src/cli-sdk/src/view.ts:29
Parameters
| Parameter | Type |
|---|---|
_result | T |
_opts | { time: number; } |
_opts.time | number |
Returns
Promise<unknown>
error()
error(_err): voidDefined in: src/cli-sdk/src/view.ts:32
Parameters
| Parameter | Type |
|---|---|
_err | unknown |
Returns
void
start()
start(): voidDefined in: src/cli-sdk/src/view.ts:28
Returns
void
Type Aliases
LazyView<T>
type LazyView<T> = object;Defined in: src/cli-sdk/src/view.ts:52
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Type declaration
| Name | Type |
|---|---|
[kLazyView] | () => Promise<View<T>> |
View<T>
type View<T> =
| ViewFn<T>
| typeof ViewClass;Defined in: src/cli-sdk/src/view.ts:41
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
ViewFn()<T>
type ViewFn<T> = (result, options, conf) => unknown;Defined in: src/cli-sdk/src/view.ts:35
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
result | T |
options | ViewOptions |
conf | LoadedConfig |
Returns
unknown
ViewOptions
type ViewOptions = object;Defined in: src/cli-sdk/src/view.ts:3
Type declaration
| Name | Type |
|---|---|
colors? | boolean |
Views<T>
type Views<T> =
| View<T>
| LazyView<T>
| Record<string, View<T> | LazyView<T>>;Defined in: src/cli-sdk/src/view.ts:67
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Functions
isLazyView()
function isLazyView<T>(v): v is LazyView<T>Defined in: src/cli-sdk/src/view.ts:60
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
v | unknown |
Returns
v is LazyView<T>
isViewClass()
function isViewClass<T>(view): view is typeof ViewClassDefined in: src/cli-sdk/src/view.ts:43
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
view | View<T> |
Returns
view is typeof ViewClass
lazyView()
function lazyView<T>(load): LazyView<T>Defined in: src/cli-sdk/src/view.ts:56
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
load | () => Promise<View<T>> |
Returns
LazyView<T>
loadLazyView()
function loadLazyView<T>(v): Promise<View<T>>Defined in: src/cli-sdk/src/view.ts:64
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
v | LazyView<T> |
Returns
Promise<View<T>>