Class VocabularyError

constructor

• new VocabularyError(options: VocabularyErrorOptions): VocabularyError

  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',
    ],
  });
  Copy

Readonlydomain

Readonlyterm

toAIContext

• toAIContext(): AIErrorContext & {
      domain: string
      | undefined;
      term: string | undefined;
  }

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

  Returns AIErrorContext & { domain: string | undefined; term: string | undefined }

  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'
  Copy

toJSON

• toJSON(): SerializedPramanError & {
      domain: string
      | undefined;
      term: string | undefined;
  }

  Serializes the error to a plain JSON-safe object.

  Returns SerializedPramanError & { domain: string | undefined; term: string | undefined }

  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'
  Copy