kui_shell_core.UsageError.md

Kui API Documentation - v11.0.0 / @kui-shell/core / UsageError

Class: UsageError

@kui-shell/core.UsageError

Hierarchy

• Error

  ↳ UsageError

Implements

• CodedError
• UsageErrorLike

Table of contents

Constructors

• constructor

Properties

• code
• formattedMessage
• message
• name
• raw
• stack
• stackTraceLimit

Methods

• getUsageModel
• captureStackTrace
• getFormattedMessage
• isUsageError
• prepareStackTrace

Constructors

constructor

• new UsageError(message, extra?)

Parameters

Name	Type
message	UsageLike
extra?	UsageOptions

Overrides

Error.constructor

Defined in

packages/core/src/core/usage-error.ts:901

Properties

code

• code: number

Implementation of

CodedError.code

Defined in

packages/core/src/core/usage-error.ts:899

---

formattedMessage

• formattedMessage: Promise<HTMLElement>

Implementation of

UsageErrorLike.formattedMessage

Defined in

packages/core/src/core/usage-error.ts:895

---

message

• message: string

Implementation of

CodedError.message

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1023

---

name

• name: string

Implementation of

CodedError.name

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1022

---

raw

• raw: UsageLike

Implementation of

UsageErrorLike.raw

Defined in

packages/core/src/core/usage-error.ts:897

---

stack

• Optional stack: string

Implementation of

CodedError.stack

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1024

---

stackTraceLimit

▪ Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:142

Methods

getUsageModel

▸ getUsageModel(): UsageModel

Returns

UsageModel

Defined in

packages/core/src/core/usage-error.ts:917

---

captureStackTrace

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Name	Type
targetObject	Object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:133

---

getFormattedMessage

▸ Static getFormattedMessage(err): Promise<HTMLElement>

Parameters

Name	Type
err	UsageErrorLike

Returns

Promise<HTMLElement>

Defined in

packages/core/src/core/usage-error.ts:921

---

isUsageError

▸ Static isUsageError(error): error is UsageErrorLike

Parameters

Name	Type
error	Entity<void, Row, ResourceWithMetadata<void>> | UsageErrorLike

Returns

error is UsageErrorLike

Defined in

packages/core/src/core/usage-error.ts:929

---

prepareStackTrace

▸ Static Optional prepareStackTrace(err, stackTraces): any

Optional override for formatting stack traces

see https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces

Parameters

Name	Type
err	Error
stackTraces	CallSite[]

Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:140