Home > SYS_Help > help

SYS_Help.help() method

查询 Help 信息（渐进式）

Signature

function help(
	namespace?: string,
	className?: string,
	methodName?: string,
): Promise<ISYS_HelpData | Record<string, any> | ISYS_HelpClassSummary | ISYS_HelpMethodDetail>;

Parameters

Parameter	Type	Description
namespace	string	(Optional) 命名空间：'eda'（静态外部 API）、'format'（lc-protocol 格式类型）或 'external'（扩展注入接口），缺省返回总览
className	string	(Optional) 类名 / 类型名 / 命名空间下的分组名（external 场景为注册时的 namespace）
methodName	string	(Optional) 方法名 / 接口名

Returns

Promise<ISYS_HelpData | Record<string, any> | ISYS_HelpClassSummary | ISYS_HelpMethodDetail>

渐进式查询结果： - 无参：返回总览 { eda: [{ name, comment } 全部类型条目], external: { namespace: { apiName: 标题 } } }； - 仅 namespace（'eda' / 'format'）：返回该命名空间下全部类型条目 [{ name, comment }]（类 / 枚举 / 接口 / 类型）； - namespace + className：类返回 { title, methods: [{ name, comment }] } 方法摘要， 枚举 / 接口 / 类型返回类型详情（{ name, comment, values } 枚举值列表或 { name, comment, fields } 字段列表）； - 三个参数齐全（'eda' 场景）：返回单方法的完整详情（入参、出参、返回值）； - 'format' 场景：仅 namespace 返回类型条目列表，namespace + className 返回该类型的详情（无 methodName 层级）

Example

// 1. 总览
const overview = await eda.sys_Help.help();

// 2. 查看 eda 下 lib_Device 类的方法
const deviceMethods = await eda.sys_Help.help('eda', 'lib_Device');

// 3. 查看 create 方法的完整用法
const createDoc = await eda.sys_Help.help('eda', 'lib_Device', 'create');

// 4. 查看外部注入接口
const externalInfo = await eda.sys_Help.help('external', 'component', 'placeComponent');