Class OpenAIError

Hierarchy

Error
- OpenAIError

Index

Constructors

Properties

cause? message name stack? type prepareStackTrace? stackTraceLimit

Methods

toJSON captureStackTrace

Constructors

constructor

new OpenAIError(type: "NO_API_KEY" | "MAX_TOKENS" | "UNKNOWN"): OpenAIError
Parameters
- type: "NO_API_KEY" | "MAX_TOKENS" | "UNKNOWN"
Returns OpenAIError
Overrides Error.constructor
- Defined in src/lib/errors.ts:14

Properties

`Optional` cause

cause?: unknown

message

message: OpenAIErrorMessage

name

name: string

`Optional` stack

stack?: string

type

type: "NO_API_KEY" | "MAX_TOKENS" | "UNKNOWN"

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Optional override for formatting stack traces
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

`Static` stackTraceLimit

stackTraceLimit: number

Methods

toJSON

toJSON(): {
message: OpenAIErrorMessage;
type: "NO_API_KEY" | "MAX_TOKENS" | "UNKNOWN";
}
Returns {
message: OpenAIErrorMessage;
type: "NO_API_KEY" | "MAX_TOKENS" | "UNKNOWN";
}
- message: OpenAIErrorMessage
- type: "NO_API_KEY" | "MAX_TOKENS" | "UNKNOWN"
- Defined in src/lib/errors.ts:24

`Static` captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4

Generated using TypeDoc