DisTubeError

Extends

• Error

Type Parameters

Type Parameter	Default type
Code extends ErrorCode	ErrorCode

Constructors

Constructor

new DisTubeError<Code>(code, message, options?): DisTubeError<Code>

Parameters

Parameter	Type
code	Code
message	string
options?	DisTubeErrorOptions

Returns

DisTubeError<Code>

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Inherited from

Error.cause

---

code

readonly code: Code

---

media?

readonly optional media?: ErrorMedia

Set by a plugin when the failure came from looking up one Song or one Playlist.

---

message

message: string

Inherited from

Error.message

---

name

name: string

Inherited from

Error.name

---

query?

readonly optional query?: string

Set when every plugin was exhausted; see DisTubeErrorOptions.query.

---

source?

readonly optional source?: string

---

stack?

optional stack?: string

Inherited from

Error.stack

Methods

is()

static is<Code>(error, code?): error is DisTubeError<Code>

Narrows error to a DisTubeError, carrying exactly code when given. Matches by name and code rather than class identity, so an error from another installed copy of the package narrows too.

Type Parameters

Type Parameter	Default type
Code extends ErrorCode	ErrorCode

Parameters

Parameter	Type
error	unknown
code?	Code

Returns

error is DisTubeError<Code>