@ably/vcdiff-decoder 中文文档教程

Question

Vcdiff Decoder

用纯 JavaScript 编写的 Vcdiff 解码器。 支持 Vcdiff 格式，如 RFC 3284 中所指定。

使用从生成的 Vcdiff 补丁/增量文件进行测试和验证 谷歌的open-vcdiff 和 Joshua MacDonald 的 xdelta。

Installation from npm for Node.js

npm install @ably/vcdiff-decoder

并要求为：

const vcdiffPlugin = require('@ably/vcdiff-decoder');

Script include for Web Browsers

从我们的 CDN 将库包含在您的 HTML 中：

<script src="https://cdn.ably.io/lib/vcdiff-decoder.min-1.js"></script>

我们遵循语义版本控制。 要锁定客户端库的主要或次要版本，您可以指定特定的版本号 - 例如：

• https://cdn.ably.io/lib/vcdiff-decoder.min-1.js for latest 1.* version
• https://cdn.ably.io/lib/vcdiff-decoder.min-1.0.js for latest v1.0.* version
• https://cdn.ably.io/lib/vcdiff-decoder.min-1.0.3.js for version 1.0.3 explicitly

您可以通过从 URL 中省略 min- 来加载非缩小版本，例如 <代码>https://cdn.ably.io/lib/vcdiff-decoder-1.js。

有关可用版本，请参阅标记的版本。

Usage

以下代码示例显示了如何将 Vcdiff 与 Ably 结合使用：

const Ably = require('ably');
const vcdiffPlugin = require('@ably/vcdiff-decoder');

const realtime = new Ably.Realtime({
    key: 'YOUR_ABLY_KEY',
    plugins: {
        vcdiff: vcdiffPlugin
    },
    log: { level: 4 } // optional
});

const channel = realtime.channels.get('your-ably-channel', {
    params: {
        delta: 'vcdiff'
    }
});

channel.subscribe(msg => console.log("Received message: ", msg));

Exported Functions

decode(delta, source)

同步解码​​。 参数：

• delta: Uint8Array - the binary Vcdiff format encoding of the patch/diff information needed to transform source to the returned target
• source: Uint8Array - the group of bytes to transform to the returned target using by applying delta

返回一个 Uint8Array，即“目标”，是将 delta 应用于 source 的结果。

Contributing

Requirements

此项目用于测试的 vcdiff 开发依赖项无法针对 Node 进行构建。 js 9 及更新版本。 出于这个原因，在解决 #3 之前，测试必须针对具有Node.js 8 安装。

在撰写本文时，这意味着：

vcdiff-decoder % node --version
v8.17.0
vcdiff-decoder % npm --version
6.13.4

对于那些使用 ASDF 或兼容的工具来管理他们的 Node.js 运行时版本，我们已经包含了一个 .tool-versions 文件。

Building

您可以使用 Webpack 触发构建：

npm run grunt -- build

在 dist 文件夹中创建 vcdiff-decoder.js 和 vcdiff-decoder.min.js。

Testing

要运行所有测试，请使用：

npm test

支持的浏览器测试

您需要为 BROWSERSTACK_USERNAME 和 BROWSERSTACK_ACCESSKEY 配置环境变量。

Release Procedure

在 main 分支上：

1. Increment the version, regenerate from source (a.k.a. build / bundle) and make a tagged commit which includes the built output from the /dist folder by running npm run grunt -- release:patch (or "major", "minor" or "prepatch" as appropriate - see grunt-bump Usage Examples)
2. Release the tagged commit to Github using git push origin main --follow-tags
3. Release to NPM using npm publish . --access public (this package is configured to require that 2FA is used by publishers)
4. Release to Ably's CDN using npm run grunt -- publish-cdn (operable by Ably staff only)
5. Visit tags and draft new release for the newly created tag