@codesoul-co/hypha-core / ids

• 包索引: @codesoul-co/hypha-core
• 源码: packages/core/src/ids.ts
• 导出数: 3

模块用法

用于使用该功能边界的公共契约与操作。Ids 模块公开 1 函数、1 接口、1 类型。

从包入口导入

import {
  formatFrameworkId,
} from '@codesoul-co/hypha-core';

import type {
  FrameworkId,
  FrameworkIdPrefix,
} from '@codesoul-co/hypha-core';

使用要点

• 2 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
• 1 个函数是该模块的直接操作入口；每个 overload 的必需/可选参数与返回类型均在下方列出。

公共导出

Symbol	种类	签名	说明
formatFrameworkId	函数	formatFrameworkId(id: FrameworkId): string	Format Framework ID 函数，提供 1 个公开调用签名；参数与返回类型见下表。
FrameworkId	接口	interface FrameworkId	Framework ID 接口，共包含 2 个公开字段或方法。
FrameworkIdPrefix	类型	type FrameworkIdPrefix = 'workspace' | 'session' | 'run' | 'step' | 'event' | 'agent' | 'skill' | 'tool' | 'memory' | 'model' | 'domain' | 'workflow' | 'policy' | 'artifact'	Framework ID Prefix 公共类型别名；完整类型表达式见声明。

formatFrameworkId

Format Framework ID 函数，提供 1 个公开调用签名；参数与返回类型见下表。

• 种类: 函数
• 导入: import { formatFrameworkId } from '@codesoul-co/hypha-core';
• 源码模块: ids

声明

export declare function formatFrameworkId(id: FrameworkId): string;

调用签名

formatFrameworkId(id: FrameworkId): string

参数

参数	类型	必需	说明
id	FrameworkId	是	必需参数；接受的值由类型列定义。

返回值

• 类型: string
• 说明: 返回值契约由上述类型定义。

FrameworkId

Framework ID 接口，共包含 2 个公开字段或方法。

• 种类: 接口
• 导入: import type { FrameworkId } from '@codesoul-co/hypha-core';
• 源码模块: ids

声明

export interface FrameworkId {
    prefix: FrameworkIdPrefix;
    value: string;
}

契约成员

成员	种类	签名	说明
prefix	属性	prefix: FrameworkIdPrefix	公开属性；类型、只读和可选状态以签名列为准。
value	属性	value: string	公开属性；类型、只读和可选状态以签名列为准。

FrameworkIdPrefix

Framework ID Prefix 公共类型别名；完整类型表达式见声明。

• 种类: 类型
• 导入: import type { FrameworkIdPrefix } from '@codesoul-co/hypha-core';
• 源码模块: ids

声明

export type FrameworkIdPrefix = 'workspace' | 'session' | 'run' | 'step' | 'event' | 'agent' | 'skill' | 'tool' | 'memory' | 'model' | 'domain' | 'workflow' | 'policy' | 'artifact';