@vltpkg/cli-sdk/view

Classes

ViewClass<T>

Defined in: src/cli-sdk/src/view.ts:17

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

• T = unknown

Constructors

new ViewClass()

new ViewClass<T>(options, config): ViewClass<T>

Defined in: src/cli-sdk/src/view.ts:21

Parameters

options

ViewOptions

config

LoadedConfig

Returns

ViewClass<T>

Properties

config

config: LoadedConfig

Defined in: src/cli-sdk/src/view.ts:19

options

options: ViewOptions

Defined in: src/cli-sdk/src/view.ts:18

Methods

done()

done(_result, _opts): undefined | string

Defined in: src/cli-sdk/src/view.ts:30

Parameters

_result

T

_opts

time

number

Returns

undefined | string

error()

error(_err): void

Defined in: src/cli-sdk/src/view.ts:33

Parameters

_err

unknown

Returns

void

start()

start(): void

Defined in: src/cli-sdk/src/view.ts:29

Returns

void

Type Aliases

View<T>

type View<T> = ViewFn<T> | typeof ViewClass

Defined in: src/cli-sdk/src/view.ts:42

Type Parameters

• T = unknown

---

ViewFn()<T>

type ViewFn<T> = (result, options, conf) => unknown

Defined in: src/cli-sdk/src/view.ts:36

Type Parameters

• T = unknown

Parameters

result

T

options

ViewOptions

conf

LoadedConfig

Returns

unknown

---

ViewOptions

type ViewOptions = object

Defined in: src/cli-sdk/src/view.ts:4

Type declaration

colors?

optional colors: ChalkInstance;

---

Views<T>

type Views<T> = View<T> | Record<string, View<T>>

Defined in: src/cli-sdk/src/view.ts:51

Type Parameters

• T = unknown

Functions

isViewClass()

function isViewClass<T>(view): view is typeof ViewClass

Defined in: src/cli-sdk/src/view.ts:44

Type Parameters

• T = unknown

Parameters

view

View<T>

Returns

view is typeof ViewClass