@ralphschuler.ai function caller.index.<internal>.APIError

Class: APIError

index.<internal>.APIError

Hierarchy

• OpenAIError

  ↳ APIError

  ↳↳ APIConnectionError

  ↳↳ APIUserAbortError

  ↳↳ NotFoundError

  ↳↳ ConflictError

  ↳↳ RateLimitError

  ↳↳ BadRequestError

  ↳↳ AuthenticationError

  ↳↳ InternalServerError

  ↳↳ PermissionDeniedError

  ↳↳ UnprocessableEntityError

Table of contents

Constructors

• constructor

Properties

• cause
• code
• error
• headers
• message
• name
• param
• stack
• status
• type
• makeMessage
• prepareStackTrace
• stackTraceLimit

Methods

• captureStackTrace
• generate

Constructors

constructor

• new APIError(status, error, message, headers): APIError

Parameters

Name	Type
status	undefined | number
error	undefined | Object
message	undefined | string
headers	undefined | Headers

Returns

APIError

Overrides

OpenAIError.constructor

Defined in

node_modules/openai/error.d.ts:11

Properties

cause

• Optional cause: unknown

Inherited from

OpenAIError.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24

---

code

• Readonly code: undefined | null | string

Defined in

node_modules/openai/error.d.ts:8

---

error

• Readonly error: undefined | Object

Defined in

node_modules/openai/error.d.ts:7

---

headers

• Readonly headers: undefined | Headers

Defined in

node_modules/openai/error.d.ts:6

---

message

• message: string

Inherited from

OpenAIError.message

Defined in

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

---

name

• name: string

Inherited from

OpenAIError.name

Defined in

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

---

param

• Readonly param: undefined | null | string

Defined in

node_modules/openai/error.d.ts:9

---

stack

• Optional stack: string

Inherited from

OpenAIError.stack

Defined in

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

---

status

• Readonly status: undefined | number

Defined in

node_modules/openai/error.d.ts:5

---

type

• Readonly type: undefined | string

Defined in

node_modules/openai/error.d.ts:10

---

makeMessage

▪ Private Static makeMessage: any

Defined in

node_modules/openai/error.d.ts:12

---

prepareStackTrace

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

Parameters

Name	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

OpenAIError.prepareStackTrace

Defined in

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

---

stackTraceLimit

▪ Static stackTraceLimit: number

Inherited from

OpenAIError.stackTraceLimit

Defined in

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

Methods

captureStackTrace

▸ captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Name	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

OpenAIError.captureStackTrace

Defined in

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

---

generate

▸ generate(status, errorResponse, message, headers): APIError

Parameters

Name	Type
status	undefined | number
errorResponse	undefined | Object
message	undefined | string
headers	undefined | Headers

Returns

APIError

Defined in

node_modules/openai/error.d.ts:13