NotionAPIError

Defined in: src/errors.ts:40

Thrown when the Notion API returns an error response.

Extends

• Error

Constructors

Constructor

new NotionAPIError(response, retryAfterMs?): NotionAPIError

Defined in: src/errors.ts:46

Parameters

response

NotionErrorResponse

retryAfterMs?

number

Returns

NotionAPIError

Overrides

Error.constructor

Properties

body

readonly body: NotionErrorResponse

Defined in: src/errors.ts:43

---

code

readonly code: NotionErrorCode

Defined in: src/errors.ts:42

---

message

message: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

---

name

name: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

Error.name

---

retryAfterMs?

readonly optional retryAfterMs?: number

Defined in: src/errors.ts:44

---

stack?

optional stack?: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.stack

---

status

readonly status: number

Defined in: src/errors.ts:41

---

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

isNotFound()

isNotFound(): boolean

Defined in: src/errors.ts:88

Check if the API could not find the requested object.

Returns

boolean

---

isRateLimited()

isRateLimited(): boolean

Defined in: src/errors.ts:67

Check if the error is a rate limit error.

Returns

boolean

---

isRetryable()

isRetryable(): boolean

Defined in: src/errors.ts:109

Check if the error is retryable (rate limit or server error).

Returns

boolean

---

isServerError()

isServerError(): boolean

Defined in: src/errors.ts:102

Check if the error is a server error (5xx).

Returns

boolean

---

isServiceOverloaded()

isServiceOverloaded(): boolean

Defined in: src/errors.ts:74

Check if the error is a service overload error (HTTP 529).

Returns

boolean

---

isUnauthorized()

isUnauthorized(): boolean

Defined in: src/errors.ts:81

Check if the error is an authentication error.

Returns

boolean

---

isValidationError()

isValidationError(): boolean

Defined in: src/errors.ts:95

Check if the error is a validation error.

Returns

boolean

---

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace