RequestError.md

@bigcommerce/checkout-sdk / RequestError

Class: RequestError<TBody>

Throw this error if we are unable to make a request to the server. It wraps any server response into a JS error object.

Type parameters

Name	Type
TBody	any

Hierarchy

• StandardError

  ↳ RequestError

Table of contents

Constructors

• constructor

Properties

• body
• errors
• headers
• name
• status
• type

Constructors

constructor

• new RequestError<TBody>(response?, __namedParameters?)

Type parameters

Name	Type
TBody	any

Parameters

Name	Type
response?	default<{} | TBody>
__namedParameters?	Object
__namedParameters.errors?	{ code: string ; message?: string }[]
__namedParameters.message?	string

Overrides

StandardError.constructor

Properties

body

• body: {} | TBody

---

errors

• errors: { code: string ; message?: string }[]

---

headers

• headers: Object

Index signature

▪ [key: string]: any

---

name

• name: string

Inherited from

StandardError.name

---

status

• status: number

---

type

• type: string

Inherited from

StandardError.type