# `easytier-ohrs` ## Install use `ohpm` to install package. ```shell ohpm install easytier-ohrs ``` ## API ### collectNetworkInfos ```ts collectNetworkInfos(): Array ```` 获取正在运行的网络实例的信息。 --- ### collectRunningNetwork ```ts collectRunningNetwork(): Array ``` 获取当前正在运行的网络实例名称列表。 --- ### convertTomlToNetworkConfig ```ts convertTomlToNetworkConfig(cfgStr: string): string ``` 将 TOML 配置转换为 NetworkConfig。 * `cfgStr`：TOML 配置内容 --- ### defaultNetworkConfig ```ts defaultNetworkConfig(): string ``` 获取默认的网络配置（JSON 字符串），用于转换为object进行赋值。 --- ### easytierVersion ```ts easytierVersion(): string ``` 获取 EasyTier 当前版本号。 --- ### hilogGlobalOptions ```ts hilogGlobalOptions(domain: number, tag: string): void ``` 设置全局日志选项。 * `domain`：日志域 ID * `tag`：日志标签 --- ### initPanicHook ```ts initPanicHook(): void ``` 初始化 panic 钩子，用于将Rust侧的panic输出到hilog中，请先通过 hilogGlobalOptions 设置hilog的参数。 --- ### initTracingSubscriber ```ts initTracingSubscriber(): void ``` 初始化 tracing 日志订阅器，用于将Rust侧日志同步输出到hilog中，请先通过 hilogGlobalOptions 设置hilog的参数。 --- ### isRunningNetwork ```ts isRunningNetwork(instId: string): boolean ``` 判断指定网络实例是否正在运行。 * `instId`：网络实例 ID --- ### parseNetworkConfig ```ts parseNetworkConfig(cfgJson: string): boolean ``` 校验网络配置（JSON 格式）是否合法。 * `cfgJson`：网络配置内容 --- ### runNetworkInstance ```ts runNetworkInstance(cfgJson: string): boolean ``` 启动网络实例。 * `cfgJson`：网络配置（JSON） --- ### setTunFd ```ts setTunFd(instId: string, fd: number): boolean ``` 为指定网络实例设置 TUN 设备文件描述符。 * `instId`：网络实例 ID * `fd`：TUN 设备文件描述符 --- ### stopNetworkInstance ```ts stopNetworkInstance(instNames: Array): void ``` 停止指定的网络实例。 * `instNames`：网络实例名称列表 ## Usage ```ts // todo ```