Skip to main content
Version: 1.x

Class: VocabularyError

Defined in: src/core/errors/vocabulary-error.ts:85

Error subclass for business vocabulary resolution failures.

Remarks​

Thrown when a business vocabulary term cannot be resolved, a domain vocabulary file fails to load, or a term maps ambiguously to multiple SAP controls or actions. Includes the term and domain fields for diagnostic context.

Sap Module​

cross-module

Business Context​

Business vocabulary resolution for SAP domain terms

Failure Mode​

Term not found — vocabulary term has no registered definition

Failure Mode​

Domain load failed — vocabulary JSON file could not be loaded

Failure Mode​

Ambiguous match — term maps to multiple SAP controls or actions

Ai Context​

Vocabulary term suggestions for AI — nearestTerms field provides alternatives

Example​

const error = new VocabularyError({
  message: 'Term not found in procurement domain',
  attempted: 'Resolve vocabulary term: vendorNumber',
  term: 'vendorNumber',
  domain: 'procurement',
  suggestions: ['Check spelling — did you mean "vendor"?'],
});

Extends​

Constructors​

Constructor​

new VocabularyError(options): VocabularyError

Defined in: src/core/errors/vocabulary-error.ts:112

Creates a new VocabularyError instance.

Parameters​

options​

VocabularyErrorOptions

Vocabulary error construction options including the optional term and domain diagnostic fields. Defaults: code = ERR_VOCAB_TERM_NOT_FOUND, retryable = false.

Returns​

VocabularyError

Example​

import { VocabularyError } from '#core/errors/vocabulary-error.js';

const error = new VocabularyError({
  message: 'Term "vendorNum" not found in procurement domain',
  attempted: 'Resolve business term: vendorNum',
  term: 'vendorNum',
  domain: 'procurement',
  suggestions: [
    'Did you mean "vendorNumber"?',
    'Use getBusinessTermSuggestions() to list available terms',
  ],
});

Overrides​

PramanError.constructor

Properties​

attempted​

readonly attempted: string

Defined in: src/core/errors/base.ts:109

Inherited from​

PramanError.attempted

cause?​

optional cause: unknown

Defined in: docs/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from​

PramanError.cause

code​

readonly code: ErrorCode

Defined in: src/core/errors/base.ts:108

Inherited from​

PramanError.code

details​

readonly details: Readonly<Record<string, unknown>>

Defined in: src/core/errors/base.ts:112

Inherited from​

PramanError.details

domain​

readonly domain: string | undefined

Defined in: src/core/errors/vocabulary-error.ts:87

message​

message: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from​

PramanError.message

name​

name: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

PramanError.name

retryable​

readonly retryable: boolean

Defined in: src/core/errors/base.ts:110

Inherited from​

PramanError.retryable

severity​

readonly severity: "error" | "info" | "warning"

Defined in: src/core/errors/base.ts:111

Inherited from​

PramanError.severity

stack?​

optional stack: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from​

PramanError.stack

suggestions​

readonly suggestions: readonly string[]

Defined in: src/core/errors/base.ts:113

Inherited from​

PramanError.suggestions

term​

readonly term: string | undefined

Defined in: src/core/errors/vocabulary-error.ts:86

timestamp​

readonly timestamp: string

Defined in: src/core/errors/base.ts:114

Inherited from​

PramanError.timestamp

stackTraceLimit​

static stackTraceLimit: number

Defined in: 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​

PramanError.stackTraceLimit

Methods​

toAIContext()​

toAIContext(): AIErrorContext & object

Defined in: src/core/errors/vocabulary-error.ts:181

Returns structured context for AI agents to reason about the vocabulary failure.

Returns​

AIErrorContext & object

AI-friendly context object with vocabulary diagnostic fields.

Remarks​

Extends the base AI context with term and domain so AI agents can suggest alternative business terms or correct domain references.

Example​

import { VocabularyError } from '#core/errors/vocabulary-error.js';

const error = new VocabularyError({
  message: 'Ambiguous term matches 2 controls',
  attempted: 'Resolve term: amount',
  code: 'ERR_VOCAB_AMBIGUOUS_MATCH',
  term: 'amount',
  domain: 'sales',
});
const context = error.toAIContext();
// context.term === 'amount', context.domain === 'sales'

Overrides​

PramanError.toAIContext

toJSON()​

toJSON(): SerializedPramanError & object

Defined in: src/core/errors/vocabulary-error.ts:146

Serializes the error to a plain JSON-safe object.

Returns​

SerializedPramanError & object

Base serialized fields plus term and domain.

Example​

import { VocabularyError } from '#core/errors/vocabulary-error.js';

const error = new VocabularyError({
  message: 'Term not found',
  attempted: 'Resolve term: vendor',
  term: 'vendor',
  domain: 'procurement',
});
const json = error.toJSON();
// json.term === 'vendor', json.domain === 'procurement'

Overrides​

PramanError.toJSON

toUserMessage()​

toUserMessage(): string

Defined in: src/core/errors/base.ts:180

Formats the error for human-readable console output.

Returns​

string

Multi-line formatted string with all diagnostic sections.

Example​

console.error(error.toUserMessage());

Inherited from​

PramanError.toUserMessage

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: 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.

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​

PramanError.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: 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​

PramanError.prepareStackTrace