open-nfse / TooManyRequestsError

Class: TooManyRequestsError

Defined in: src/errors/http.ts:106

Extends

• HttpStatusError

Constructors

Constructor

new TooManyRequestsError(body: string | undefined, options?: HttpStatusErrorOptions): TooManyRequestsError;

Defined in: src/errors/http.ts:107

Parameters

Parameter	Type
body	string | undefined
options?	HttpStatusErrorOptions

Returns

TooManyRequestsError

Overrides

HttpStatusError.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
body	readonly	string | undefined	-	HttpStatusError.body	src/errors/http.ts:30
cause?	public	unknown	-	HttpStatusError.cause	node_modules/typescript/lib/lib.es2022.error.d.ts:26
headers	readonly	Readonly<Record<string, string>>	-	HttpStatusError.headers	src/errors/http.ts:26
message	public	string	-	HttpStatusError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	HttpStatusError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
stack?	public	string	-	HttpStatusError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078
stackTraceLimit	static	number	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.	HttpStatusError.stackTraceLimit	node_modules/@types/node/globals.d.ts:68
status	readonly	number	-	HttpStatusError.status	src/errors/http.ts:29

Methods

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

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

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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

HttpStatusError.captureStackTrace

---

getRetryAfterMs()

getRetryAfterMs(): number | undefined;

Defined in: src/errors/http.ts:53

Parse Retry-After per RFC 7231 §7.1.3, returning the delay in milliseconds (or undefined when missing/malformed/signed).

Strict RFC delta-seconds is non-negative integer only, but the parser is intentionally lenient on one real-world deviation: decimal seconds (12.5) — some servers send fractional values; we round up to whole seconds via Math.ceil (12.5 → 13s).

HTTP-date values in the past return 0 (ready immediately).

Explicitly rejects any leading sign (-5, +60) before falling through to numeric / date branches. Date.parse('-5') returns 0 on V8, which would silently route to the past-date branch and yield a 0ms delay — wrong.

Returns

number | undefined

Inherited from

HttpStatusError.getRetryAfterMs

---

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

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

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

HttpStatusError.prepareStackTrace