@vltpkg/cli-sdk/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

• T = unknown

Constructors

new ViewClass()

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

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

Parameters

options

ViewOptions

config

ParsedConfig

Returns

ViewClass<T>

Properties

config

config: ParsedConfig

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

options

options: ViewOptions

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

Methods

done()

done(_result, _opts): Promise<unknown>

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

Parameters

_result

T

_opts

time

number

Returns

Promise<unknown>

error()

error(_err): void

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

Parameters

_err

unknown

Returns

void

start()

start(): void

Defined 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

• T = unknown

Type declaration

[kLazyView]()

readonly [kLazyView]: () => Promise<View<T>>;

Returns

Promise<View<T>>

---

View<T>

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

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

Type Parameters

• T = unknown

---

ViewFn()<T>

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

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

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:3

Type declaration

colors?

optional 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

• T = unknown

Functions

isLazyView()

function isLazyView<T>(v): v is LazyView<T>

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

Type Parameters

• T = unknown

Parameters

v

unknown

Returns

v is LazyView<T>

---

isViewClass()

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

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

Type Parameters

• T = unknown

Parameters

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

• T

Parameters

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

• T

Parameters

v

LazyView<T>

Returns

Promise<View<T>>