RateLimitError

Error thrown when rate limit is exceeded (429 errors) Common scenarios: - Too many requests in a time window - API throttling

Extends¶

UiPathError

Constructors¶

Constructor¶

new RateLimitError(params: Partial<ErrorParams>): RateLimitError

Parameters¶

Parameter	Type
`params`	`Partial`<`ErrorParams`>

Returns¶

RateLimitError

Overrides¶

UiPathError.constructor

Properties¶

Property	Modifier	Type	Description
`message`	`public`	`string`	-
`name`	`public`	`string`	-
`requestId?`	`readonly`	`string`	Request ID for tracking with UiPath support
`stack?`	`public`	`string`	-
`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.
`statusCode?`	`readonly`	`number`	HTTP status code (400, 401, 403, 404, 500, etc.)
`timestamp`	`readonly`	`Date`	Timestamp when the error occurred
`type`	`readonly`	`string`	Error type identifier (e.g., "AuthenticationError", "ValidationError")

Methods¶

captureStackTrace()¶

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

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();