ActivityPlug

Appearance

ActivityPlug API / @activityplug/core / BudgetExhaustedError

Class: BudgetExhaustedError ​

Defined in: packages/core/src/security/budget.ts:56

Extends ​

Constructors ​

Constructor ​

new BudgetExhaustedError(dimension, limit, used, requested, operation): BudgetExhaustedError

Defined in: packages/core/src/security/budget.ts:57

Parameters ​

dimension ​

"bytes" | "reads" | "nodes" | "depth" | "requests" | "activeAllocations" | "concurrency" | "deadline"

limit ​

number

used ​

number

requested ​

number

operation ​

string

Returns ​

BudgetExhaustedError

Overrides ​

ActivityPlugError.constructor

Properties ​

cause? ​

optional cause?: unknown

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from ​

ActivityPlugError.cause

code ​

readonly code: ActivityPlugErrorCode

Defined in: packages/core/src/errors/error.ts:39

Inherited from ​

ActivityPlugError.code

context ​

readonly context: ActivityPlugErrorContext

Defined in: packages/core/src/errors/error.ts:40

Inherited from ​

ActivityPlugError.context

dimension ​

readonly dimension: "bytes" | "reads" | "nodes" | "depth" | "requests" | "activeAllocations" | "concurrency" | "deadline"

Defined in: packages/core/src/security/budget.ts:58

limit ​

readonly limit: number

Defined in: packages/core/src/security/budget.ts:59

message ​

message: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from ​

ActivityPlugError.message

name ​

readonly name: "ActivityPlugError" = "ActivityPlugError"

Defined in: packages/core/src/errors/error.ts:38

Inherited from ​

ActivityPlugError.name

requested ​

readonly requested: number

Defined in: packages/core/src/security/budget.ts:61

stack? ​

optional stack?: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from ​

ActivityPlugError.stack

used ​

readonly used: number

Defined in: packages/core/src/security/budget.ts:60

stackTraceLimit ​

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@[email protected]/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 ​

ActivityPlugError.stackTraceLimit

Methods ​

captureStackTrace() ​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@[email protected]/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.

js
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:

js
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 ​

ActivityPlugError.captureStackTrace

prepareStackTrace() ​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@[email protected]/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 ​

ActivityPlugError.prepareStackTrace