Yabble 使用与技术文档

1. 安装指南

Yabble 是一个通用的浏览器端 CommonJS 模块加载器。以下是安装 Yabble 的步骤：

1. 下载 Yabble 的最新版本。
2. 将下载的文件放入您的项目目录中。
3. 确保您的项目环境支持异步 XHR/eval() 或 script 标签加载模块。

2. 项目使用说明

Yabble 提供了多种方法来加载和使用模块。以下是一些基本的使用说明：

配置模块根路径

require.setModuleRoot(path);

使用此方法来配置查找模块的根路径。这可以视为 require.paths 中的一个条目。

使用 script 标签

默认情况下，Yabble 使用 XHR+eval() 来加载未包装的模块。如果要使用 script 标签并期望包装过的模块，请调用以下方法：

require.useScriptTags();

运行模块

require.run(programId);

此方法用于启动使用指定模块 ID 的应用程序。

异步加载模块

require.ensure(dependencies, callback);

详细使用请参考 Async/A 相关文档。此方法可用于检索模块并在不使用 require.run() 的情况下运行代码。

3. 项目API使用文档

以下是 Yabble 提供的一些核心 API 方法：

设置模块根路径

require.setModuleRoot(path);

• 参数：path - 模块根路径。
• 描述：配置查找模块的根路径。

使用 script 标签

require.useScriptTags();

• 描述：配置 Yabble 使用 script 标签来加载模块。

运行模块

require.run(programId);

• 参数：programId - 要运行的模块 ID。
• 描述：启动使用指定模块 ID 的应用程序。

异步加载模块

require.ensure(dependencies, callback);

• 参数：
  • dependencies - 依赖模块列表。
  • callback - 加载完成后的回调函数。
• 描述：异步加载指定依赖模块，并在加载完成后执行回调函数。

4. 项目安装方式

Yabble 可以通过以下方式安装：

1. 手动下载 Yabble 的最新版本，并将其放入项目目录。
2. 使用包管理工具（如 npm）安装 Yabble。

npm install yabble

确保在安装后正确配置 Yabble 的路径和参数。