RateLimitExceededError

Defined in: packages/pipeline-rate-limit/src/errors/rate-limit-exceeded.error.ts:10

Thrown by RateLimitBehavior when a request exceeds its allotted points for the current window.

Map it to HTTP 429 Too Many Requests with RateLimitExceededFilter, which also emits a Retry-After header from retryAfterSeconds.

Extends

• Error

Constructors

Constructor

new RateLimitExceededError(params): RateLimitExceededError

Defined in: packages/pipeline-rate-limit/src/errors/rate-limit-exceeded.error.ts:29

Parameters

params

key

string

limit?

number

msBeforeNext

number

points?

number

remainingPoints

number

requestName

string

Returns

RateLimitExceededError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

---

key

readonly key: string

Defined in: packages/pipeline-rate-limit/src/errors/rate-limit-exceeded.error.ts:12

The rate-limit bucket key that was exhausted.

---

limit?

readonly optional limit?: number

Defined in: packages/pipeline-rate-limit/src/errors/rate-limit-exceeded.error.ts:22

Configured point capacity per window, when known.

---

message

message: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

---

msBeforeNext

readonly msBeforeNext: number

Defined in: packages/pipeline-rate-limit/src/errors/rate-limit-exceeded.error.ts:16

Milliseconds until the caller may retry.

---

name

name: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

Error.name

---

points?

readonly optional points?: number

Defined in: packages/pipeline-rate-limit/src/errors/rate-limit-exceeded.error.ts:27

Points the rejected request asked for, when known. A request costing more than limit can never pass, whatever the wait.

---

remainingPoints

readonly remainingPoints: number

Defined in: packages/pipeline-rate-limit/src/errors/rate-limit-exceeded.error.ts:20

Points remaining in the window (typically 0 here).

---

requestName

readonly requestName: string

Defined in: packages/pipeline-rate-limit/src/errors/rate-limit-exceeded.error.ts:14

The request that was throttled, e.g. CreateUserCommand.

---

retryAfterSeconds

readonly retryAfterSeconds: number

Defined in: packages/pipeline-rate-limit/src/errors/rate-limit-exceeded.error.ts:18

Seconds until the caller may retry (rounded up), for Retry-After.

---

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.stack

---

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@26.6.4/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

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@26.6.4/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/.pnpm/@types+node@26.6.4/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