OutputIssue
KIT · interface · Type contract
Output problem with a guaranteed field path.
Import
ts
import type { OutputIssue } from '@jangts/agent-core/kits/presentation';js
/** @typedef {import('@jangts/agent-core/kits/presentation').OutputIssue} OutputIssue */Other public entry points:@jangts/agent-core/types, @jangts/agent-core/kits/presentation, @jangts/agent-core/kits.
Definition
ts
interface OutputIssueExtends or implements: Issue.
Field structure
| Field | Type | Required | Description |
|---|---|---|---|
path | readonly (string | number)[] | Required | Read-only. See the type definition and usage context. |
code | string | Required | Read-only. Stable machine-readable reason code; the primary key for programmatic handling. |
message | string | Required | Read-only. Human-readable description; not guaranteed stable for matching. |
checkId | string | undefined | Optional | Read-only. Registered check that produced the issue, when the check belongs to a catalog. |
Using the type
Read the contract at the call site
ts
import type { OutputIssue } from '@jangts/agent-core/kits/presentation';
// Keep the original contract at the call site; TS and JS share the same runtime behavior.
function inspect(value: OutputIssue) {
return value.path;
}js
/** @param {import('@jangts/agent-core/kits/presentation').OutputIssue} value */
function inspect(value) {
return value.path;
}