Skip to main content

Class: PipelineError

Defined in: packages/core/src/pipeline/types.ts:415

Enhanced error class with full pipeline trace. Shows the complete path through the pipeline where error occurred.

Example​

try {
  await pipeline(step1, step2, step3).process(input);
} catch (error) {
  if (error instanceof PipelineError) {
    console.log('Pipeline trace:', error.stepTrace);
    // Output: Pipeline error at step 2 (when:checkQuality) → onPass → markPublished: Validation failed
  }
}

Extends​

  • Error

Constructors​

Constructor​

new PipelineError(message, stepTrace, cause): PipelineError

Defined in: packages/core/src/pipeline/types.ts:422

Parameters​

message​

string

stepTrace​

StepTraceEntry[]

cause​

Error

Returns​

PipelineError

Overrides​

Error.constructor

Properties​

cause​

readonly cause: Error

Defined in: packages/core/src/pipeline/types.ts:420

Original error that was thrown

message​

message: string

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

Inherited from​

Error.message

name​

name: string

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

Inherited from​

Error.name

stack?​

optional stack?: string

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

Inherited from​

Error.stack

stepTrace​

readonly stepTrace: StepTraceEntry[]

Defined in: packages/core/src/pipeline/types.ts:417

Full trace of steps leading to error

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/.bun/@types+node@24.12.4/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​

Error.stackTraceLimit

Methods​

formatTrace()​

formatTrace(): string

Defined in: packages/core/src/pipeline/types.ts:437

Format the step trace as a readable string

Returns​

string

toString()​

toString(): string

Defined in: packages/core/src/pipeline/types.ts:451

Override toString to show formatted trace

Returns​

string

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.bun/@types+node@24.12.4/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​

Error.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.bun/@types+node@24.12.4/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​

Error.prepareStackTrace