Interface: APIResponse<dataType>

types/general.APIResponse

Type parameters

Name
dataType

Table of contents

Properties

• data
• error
• rateLimits
• status
• url

Properties

data

• Optional data: dataType

Response from API

Defined in

types/general.ts:30

---

error

• Optional error: ErrorObject

Error object (if there is)

Defined in

types/general.ts:38

---

rateLimits

• rateLimits: RateLimit

Information about current rate limits

Defined in

types/general.ts:34

---

status

• status: number

Response status

Remarks

• 200-299 Successful response
• 400-499 Client error response
• 500-599 Server error response

Defined in

types/general.ts:26

---

url

• url: string

Original request URL

Defined in

types/general.ts:42