@oneplatform/plugin-sdk / PluginConfigError

Class: PluginConfigError¶

Defined in: packages/plugin-sdk/src/types/errors.ts:104

A required configuration field is missing or has an invalid value. isRetryable=false: configuration is static; retrying without configuration change will produce the same error.

Throw this from connect() when a required config field is absent or invalid. Do not throw this from fetchBatch — configuration issues should be caught at connect() time.

Extends¶

PluginError

Constructors¶

Constructor¶

new PluginConfigError(message, field?): PluginConfigError

Defined in: packages/plugin-sdk/src/types/errors.ts:105

Parameters¶

message¶

string

field?¶

string

The name of the config field that is missing or invalid.

Returns¶

PluginConfigError

Overrides¶

PluginError.constructor

Properties¶

cause?¶

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from¶

PluginError.cause

code¶

readonly code: string

Defined in: packages/plugin-sdk/src/types/errors.ts:23

Machine-readable error code, e.g., "INVALID_CURSOR". Snake_case, uppercase.

Inherited from¶

PluginError.code

details?¶

readonly optional details?: Record\<string, unknown>

Defined in: packages/plugin-sdk/src/types/errors.ts:31

Structured context for debugging. Never include credential values.

Inherited from¶

PluginError.details

field?¶

readonly optional field?: string

Defined in: packages/plugin-sdk/src/types/errors.ts:108

The name of the config field that is missing or invalid.

isRetryable¶

readonly isRetryable: boolean

Defined in: packages/plugin-sdk/src/types/errors.ts:29

Whether the Execution Service should retry this execution. true: transient failure, retry with backoff (rate limits, timeouts, 5xx) false: permanent failure, route to DLQ immediately (bad config, bad data)

Inherited from¶

PluginError.isRetryable

message¶

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from¶

PluginError.message

name¶

name: string

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

Inherited from¶

PluginError.name

stack?¶

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from¶

PluginError.stack

stackTraceLimit¶

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@20.19.42/node_modules/@types/node/globals.d.ts:68

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¶

PluginError.stackTraceLimit

Methods¶

captureStackTrace()¶

static captureStackTrace(targetObject, constructorOpt?): void

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

targetObject¶

object

constructorOpt?¶

Function

Returns¶

void

Inherited from¶

PluginError.captureStackTrace

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

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

Parameters¶

err¶

Error

stackTraces¶

CallSite[]

Returns¶

any

See¶

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

Inherited from¶

PluginError.prepareStackTrace