Share via


RestError interface

A custom error type for failed pipeline requests.

Extends

Error

Properties

code

The code of the error itself (use statics on RestError if possible.)

details

Bonus property set by the throw site.

request

The request that was made. This property is non-enumerable.

response

The response received (if any.) This property is non-enumerable.

statusCode

The HTTP status code of the request (if applicable.)

Inherited Properties

message
name
stack

Property Details

code

The code of the error itself (use statics on RestError if possible.)

code?: string

Property Value

string

details

Bonus property set by the throw site.

details?: unknown

Property Value

unknown

request

The request that was made. This property is non-enumerable.

request?: PipelineRequest

Property Value

response

The response received (if any.) This property is non-enumerable.

response?: PipelineResponse

Property Value

statusCode

The HTTP status code of the request (if applicable.)

statusCode?: number

Property Value

number

Inherited Property Details

message

message: string

Property Value

string

Inherited From Error.message

name

name: string

Property Value

string

Inherited From Error.name

stack

stack?: string

Property Value

string

Inherited From Error.stack