云浮速度测试

@cloudflare/speedtest 是一个用于测量客户端互联网连接质量的 JavaScript 模块。 使用Cloudflare 速度测试测量应用程序的测量引擎 https://speed.cloudflare.com (中文(中国大陆) )。 。 。 .

模块针对 云雾花 边缘网络并依赖 性能资源Timing 浏览器 api 以获取计时结果. 网络连接的特点是有下载/上载带宽、延迟和包丢失等项目.

请注意,Cloudflare在完成后收集测量结果,以便计算关于互联网连接质量的综合见解.

安装

将此软件包添加到您的 package.json 在您的项目目录根中运行此选项 :

npm install @cloudflare/speedtest

简单使用

import SpeedTest from '@cloudflare/speedtest';

new SpeedTest().onFinish = results => console.log(results.getSummary());

API 参考

SpeedTest 是一个 JavaScript 类,应该与 new 关键词 不需要通过一个配置对象,因为所有项目都有默认值.

证据

new SpeedTest({ configOptions })

标有QQ的选项是 实验和不稳定:它们可能改变行为, 重新命名,或在任何发布中被删除,包括补丁。 不依赖 他们.

属性

方法

通知事件

测量配置

试验发动机将进行的具体测量(及其序列)可使用 measurements 配置选项 。 这应该是一系列物体,每个物体都有 type 字段,加上该计量类型特有的额外字段.

由引擎执行的默认测量数据集是:

[
  { type: 'latency', numPackets: 1 }, // initial latency estimation
  { type: 'download', bytes: 1e5, count: 1, bypassMinDuration: true }, // initial download estimation
  { type: 'latency', numPackets: 20 },
  { type: 'download', bytes: 1e5, count: 9 },
  { type: 'download', bytes: 1e6, count: 8 },
  { type: 'upload', bytes: 1e5, count: 8 },
  { type: 'upload', bytes: 1e6, count: 6 },
  { type: 'download', bytes: 1e7, count: 6 },
  { type: 'upload', bytes: 1e7, count: 4 },
  { type: 'download', bytes: 2.5e7, count: 4 },
  { type: 'upload', bytes: 2.5e7, count: 4 },
  { type: 'download', bytes: 1e8, count: 3 },
  { type: 'upload', bytes: 5e7, count: 3 },
  { type: 'download', bytes: 2.5e8, count: 2 }
]

以下是每个测量类型的可用字段:

延迟

下载/上传

每一个这些计量集都与特定的文件大小相接. 发动机遵循了每个方向(下载或上传)的坡道方法. 当一个方向有多个测量组(文件大小增加)时,引擎会继续运行,直到达到指定条件 bandwidthFinishRequestDuration,此时将忽略进一步朝同一方向设置.

数据包损失

通过向WebRTC TURN服务器提交一组UDP数据包,以及确定有多少数据包没有到达,来测量包的损失。 提交这些包可以采用分批方式,其中分批之间有睡眠时间.

包丢失是选入的:它不是默认测量的一部分,它需要你自己的TURN服务器配置. 为了启用它,增加一个 packetLoss 测量,以及:

• 设定 turnServerCredsApiUrl 返回 TURN 证书的结束点,加 turnServerUri (例如:. turn.cloudflare.com:3478),除非终点也返回 a server 字段,或
• 设定 turnServerUri 与你自己的 turnServerUser 财务报告和审定财务报表 turnServerPass。 。 。 .

new SpeedTest({
  turnServerUri: 'turn.cloudflare.com:3478',
  turnServerCredsApiUrl: 'https://turn.example.com/turn-credentials',
  measurements: [
    // ...
    { type: 'packetLoss', numPackets: 1e3, responsesWaitTime: 3000 }
  ]
});

A 类 packetLoss 无任一选项的测量因出错而失败,引擎会继续到下一个测量.

使用 Cloudflare Worker 提供 TURN 证书的示例代码 Cloudflare 实时 TURN 服务器,可在 实例/回合-工作者. 参考工人的 文档 用于设置和部署指令.

结果对象

用于获取速度测试测量结果的一个实例对象. 此对象有以下方法: