DefinitionReader
SUPPORT · interface · 类型合同
Read-only roots. A typed read describes the expected contract, not a static id/type lookup.
导入
ts
import type { DefinitionReader } from '@jangts/agent-core/support/decorators';js
/** @typedef {import('@jangts/agent-core/support/decorators').DefinitionReader} DefinitionReader */其他公开入口:@jangts/agent-core/support/decorators。
定义
ts
interface DefinitionReader<Definition>泛型参数
| 类型参数 | 约束 | 默认类型 |
|---|---|---|
Definition | IdentifiedDefinition | — |
字段结构
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
get | <Value extends Definition = Definition>(id: string, ns?: string) => Value | undefined | 必需 | 见类型定义及调用场景。 |
getAll | <Value extends Definition = Definition>(ns?: string) => readonly Value[] | 必需 | 见类型定义及调用场景。 |
pick | <Value extends Definition = Definition>(ids: readonly string[], ns?: string) => readonly Value[] | 必需 | 见类型定义及调用场景。 |
成员目录
| 成员 | 用途 |
|---|---|
get | 完整输入输出见下方重载。 |
getAll | 完整输入输出见下方重载。 |
pick | 完整输入输出见下方重载。 |
成员详情
get
ts
DefinitionReader.get<Value extends Definition = Definition>(id: string, ns?: string): Value | undefined| 类型参数 | 约束 | 默认类型 |
|---|---|---|
Value | IdentifiedDefinition | Definition |
| 参数 | 类型 | 传递 | 说明 |
|---|---|---|---|
id | string | 必需 | — |
ns | string | undefined | 可省略 | — |
返回: Value \| undefined。
getAll
ts
DefinitionReader.getAll<Value extends Definition = Definition>(ns?: string): readonly Value[]| 类型参数 | 约束 | 默认类型 |
|---|---|---|
Value | IdentifiedDefinition | Definition |
| 参数 | 类型 | 传递 | 说明 |
|---|---|---|---|
ns | string | undefined | 可省略 | — |
返回: readonly Value[]。
pick
ts
DefinitionReader.pick<Value extends Definition = Definition>(ids: readonly string[], ns?: string): readonly Value[]| 类型参数 | 约束 | 默认类型 |
|---|---|---|
Value | IdentifiedDefinition | Definition |
| 参数 | 类型 | 传递 | 说明 |
|---|---|---|---|
ids | readonly string[] | 必需 | — |
ns | string | undefined | 可省略 | — |
返回: readonly Value[]。
使用示例
- 装饰器:处理类与已有实例方法:类装饰代办定义实例化,方法装饰绑定原对象;输出仍走原 define、构造和 bind。
类拥有配置与私有辅助方法,不手写 new
入门 · TypeScript 标准装饰器
ts
import { AgentCoreEngine, defineWorkflow } from '@jangts/agent-core';
import type { WorkflowNode } from '@jangts/agent-core';
import { node, nodePool } from '@jangts/agent-core/support/decorators';
import type { Node } from '@jangts/agent-core/support/decorators';
type State = { text: string; answer?: string };
@node<State, string>('greet', { ns: 'greeting' })
class Greeting implements Node<State, string> {
readonly description = '生成问候';
readonly routes = [{ complete: (state: Readonly<State>) => state.answer! }];
#prefix = '你好,';
run(state: Readonly<State>) { return { answer: this._format(state.text) }; }
private _format(text: string) { return this.#prefix + text.trim(); }
}
const flow = defineWorkflow<State, string>({ id: 'greeting', nodes: nodePool.getAll('greeting') });
console.log(await new AgentCoreEngine({ workflow: flow }).run({ text: '访客' }));js
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
};
import { AgentCoreEngine, defineWorkflow } from '@jangts/agent-core';
import { node, nodePool } from '@jangts/agent-core/support/decorators';
let Greeting = class Greeting {
description = '生成问候';
routes = [{ complete: (state) => state.answer }];
#prefix = '你好,';
run(state) { return { answer: this._format(state.text) }; }
_format(text) { return this.#prefix + text.trim(); }
};
Greeting = __decorate([
node('greet', { ns: 'greeting' })
], Greeting);
const flow = defineWorkflow({ id: 'greeting', nodes: nodePool.getAll('greeting') });
console.log(await new AgentCoreEngine({ workflow: flow }).run({ text: '访客' }));保留服务方法名,自动绑定原对象
配置 · TypeScript 标准装饰器
ts
import type { WorkflowNode } from '@jangts/agent-core';
import { node, nodePool } from '@jangts/agent-core/support/decorators';
type State = { text: string; answer?: string };
class GreetingService {
constructor(private readonly prefix: string) {}
@node<State, string>('reply', { ns: 'service',
description: '调用现有服务',
routes: [{ complete: (state: Readonly<State>) => state.answer! }],
})
answer(state: Readonly<State>) { return { answer: this.prefix + state.text }; }
}
const service = new GreetingService('你好,');
const definition = nodePool.get<WorkflowNode<State, string>>('reply', 'service')!;
console.log(definition === nodePool.get('reply', 'service'));js
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
};
import { node, nodePool } from '@jangts/agent-core/support/decorators';
class GreetingService {
prefix;
constructor(prefix) {
this.prefix = prefix;
}
answer(state) { return { answer: this.prefix + state.text }; }
}
__decorate([
node('reply', { ns: 'service',
description: '调用现有服务',
routes: [{ complete: (state) => state.answer }],
})
], GreetingService.prototype, "answer", null);
const service = new GreetingService('你好,');
const definition = nodePool.get('reply', 'service');
console.log(definition === nodePool.get('reply', 'service'));