`$script.js` 技术文档

1. 安装指南

$script.js 是一个异步的 JavaScript 加载器和依赖管理器，具有惊人的轻量级占用。在开始使用之前，您需要确保您的环境满足以下要求：

• 浏览器支持：IE 6+、Opera 10+、Safari 3+、Chrome 1+、Firefox 2+

如果您使用的是 Node.js 环境，可以通过 npm 安装 $script.js：

npm install scriptjs

在浏览器环境中，您可以从官方提供的 CDN 链接或者自己的服务器上获取 $script.js 文件，并在 HTML 页面中通过 <script> 标签引入：

<script src="path/to/$script.js"></script>

确保在您的页面中正确引入 $script.js 文件，再进行后续操作。

2. 项目的使用说明

$script.js 允许您按需异步加载 JavaScript 资源，而不会阻塞其他资源的加载（如 CSS 和图片）。以下是一些基本的使用方法：

加载单个脚本

$script('path/to/foo.js', function() {
  // foo.js 已经加载完毕
});

同时加载多个脚本

$script(['path/to/foo.js', 'path/to/bar.js'], function() {
  // foo.js 和 bar.js 都已经加载完毕
});

使用命名空间

$script('path/to/foo.js', 'foo');
$script('path/to/bar.js', 'bar');
$script.ready('foo', function() {
  // foo.js 已经加载完毕
});
$script.ready('bar', function() {
  // bar.js 已经加载完毕
});

处理依赖关系

var dependencyList = {
  foo: 'path/to/foo.js',
  bar: 'path/to/bar.js',
  thunk: ['path/to/thunkor.js', 'path/to/thunky.js']
};

$script.ready(['foo', 'bar', 'thunk'], function () {
  // 所有依赖都已加载完毕
}, function(depsNotFound) {
  // 处理未找到的依赖
  depsNotFound.forEach(function(dep) {
    $script(dependencyList[dep], dep);
  });
});

3. 项目API使用文档

以下是一些主要的 API 方法，您可以用来操作 $script.js：

$script(path, [id], [callback])

异步加载单个或多个脚本文件。

• path: 要加载的脚本文件的路径。
• [id] (可选): 为脚本文件设置一个标识符，用于后续的 $script.ready() 或 $script.done() 调用。
• [callback] (可选): 脚本加载完毕后调用的回调函数。

$script.ready(id, [callback])

当指定的脚本或依赖集合加载完毕时，执行回调函数。

• id: 脚本的标识符。
• [callback] (可选): 回调函数。

$script.done(id)

标识特定的脚本或依赖集合加载完毕。

• id: 脚本的标识符。

$script.path([path])

设置脚本文件的基路径。

• [path] (可选): 基路径字符串。

$script.urlArgs([args])

添加 URL 参数到脚本路径，通常用于缓存清除。

• [args] (可选): 要添加的查询字符串参数。

4. 项目安装方式

$script.js 的安装方式非常简单，以下是一些常见的安装步骤：

• 通过 npm 安装（Node.js 环境）：

npm install scriptjs

• 通过 CDN 或本地服务器：

在 HTML 文件中引入 $script.js：

<script src="path/to/$script.js"></script>

确保您已经正确地引入了 $script.js 文件，然后按照上述使用说明开始使用 $script.js 吧！