CompiledReplyFormat

KIT · interface · Type contract

A resolved format with its checks bound; callers only inspect replies using it.

Import

TypeScript

import type { CompiledReplyFormat } from '@jangts/agent-core/kits/presentation';

JavaScript

/** @typedef {import('@jangts/agent-core/kits/presentation').CompiledReplyFormat} CompiledReplyFormat */

Other public entry points:@jangts/agent-core/types, @jangts/agent-core/kits/presentation, @jangts/agent-core/kits.

Definition

interface CompiledReplyFormat

Field structure

Field	Type	Required	Description
id	string	Required	Read-only. See the type definition and usage context.
description	string	Required	Read-only. See the type definition and usage context.
checks	readonly string[]	Required	Read-only. See the type definition and usage context.
inspect	(bubbles: readonly string[]) => readonly ReplyFormatCheck[]	Required	Read-only. Checks the reply fails; empty means the template format is satisfied.

Member index

Member	Purpose
inspect	Checks the reply fails; empty means the template format is satisfied.

Member details

inspect

Checks the reply fails; empty means the template format is satisfied.

CompiledReplyFormat.inspect(bubbles: readonly string[]): readonly ReplyFormatCheck[]

Parameter	Type	Passing	Description
bubbles	readonly string[]	Required	—

Returns: readonly ReplyFormatCheck[].

Using the type

Read the contract at the call site

TypeScript

import type { CompiledReplyFormat } 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: CompiledReplyFormat) {
  return value.id;
}

JavaScript

/** @param {import('@jangts/agent-core/kits/presentation').CompiledReplyFormat} value */
function inspect(value) {
  return value.id;
}

Related definitions

• ReplyFormatCheck