WorkflowContractError

CORE · class · Runtime value

The workflow definition violates Core's execution contract, as opposed to failing business logic.

Examples: unknown model binding, asynchronous predicate, unmatched route, missing state field. It is a programming error, so callers should not treat it as retryable.

Import

TypeScript

import { WorkflowContractError } from '@jangts/agent-core/engine';

JavaScript

import { WorkflowContractError } from '@jangts/agent-core/engine';

Other public entry points:@jangts/agent-core, @jangts/agent-core/engine, @jangts/agent-core/types, @jangts/agent-core/structs, @jangts/agent-core/errors.

Definition

class WorkflowContractError

Extends or implements: Error.

Constructor

new WorkflowContractError(message: string): WorkflowContractError

Parameter	Type	Passing	Description
message	string	Required	—

Returns: WorkflowContractError.

Instance properties

Field	Type	Required	Description
code	"WORKFLOW_CONTRACT"	Required	Read-only. See the type definition and usage context.

Examples

• Attempt budgets and error ownership: Express used attempts, invalid data, and workflow contract errors separately instead of turning every failure into successful prose.

Allow only two business attempts

Beginner · Node.js

TypeScript

import { AttemptBudget } from '@jangts/agent-core/engine';
const attempts = new AttemptBudget(2);
while (attempts.take()) console.log('attempt', attempts.used);
console.log(attempts.available); // false

JavaScript

import { AttemptBudget } from '@jangts/agent-core/engine';
const attempts = new AttemptBudget(2);
while (attempts.take())
    console.log('attempt', attempts.used);
console.log(attempts.available); // false

Distinguish an exhausted quota from invalid data

Configuration · Node.js

TypeScript

import { BudgetError, ValidationError, getErrorInfo } from '@jangts/agent-core';
function requireAnswer(answer: string) {
  if (!answer.trim()) throw new ValidationError([{ code: 'ANSWER_EMPTY', message: '回答不能为空' }]);
  return answer;
}
try { requireAnswer(''); }
catch (error) { console.log(getErrorInfo(error)); }
const exhausted = new BudgetError('本次业务的尝试额度已用尽');
console.log(getErrorInfo(exhausted));

JavaScript

import { BudgetError, ValidationError, getErrorInfo } from '@jangts/agent-core';
function requireAnswer(answer) {
    if (!answer.trim())
        throw new ValidationError([{ code: 'ANSWER_EMPTY', message: '回答不能为空' }]);
    return answer;
}
try {
    requireAnswer('');
}
catch (error) {
    console.log(getErrorInfo(error));
}
const exhausted = new BudgetError('本次业务的尝试额度已用尽');
console.log(getErrorInfo(exhausted));