@gideo-llc/backflaze-b2-upload- any (英语)
智能上传功能,用于其中 后发-b2 模块。 此函数可以上传缓冲、流和本地文件,并自动使用 B2 的 大文件上传 酌情建立机制.
- 上传令牌管理 : 维护一桶可以再用于未来请求的已使用上传符,允许大量简化的平行上传而无需手动管理上传符.
- 智能自动重试 : 如果目标舱忙于接收上传,在获得新的上传令牌后会自动被重审. 相继出错会导致指数倒置. 这个
retry-afterHTTP 响应头被尊重 . - 自动重授权 : 401出错会导致自动再授权. 被中断的上传将透明地重试 .
- 串流支持 : 上传的文件可以作为流提供.
- 文件支持 : 磁盘上的文件可以上传. 此例具有独特的优化, 无法用流对象进行 .
- 自动大文件上传 : 如果上传的数据大于指定的阈值,则会使用B2的大文件API自动被上传到多块中. (当数据以流提供时,流中的某些部分可能会被缓冲入内存. 这对于便于在信使过期时进行再审是必要的。 )
快开始
无侵犯性
const B2 = require('backblaze-b2');
B2.prototype.uploadAny = require('@gideo-llc/backblaze-b2-upload-any');
const b2 = new B2({
applicationKeyId: '...',
applicationKey: '...',
});
b2.authorize()
.then(r =>
b2.uploadAny({
bucketId: '...',
fileName: 'foo',
partSize: r.data.recommendedPartSize,
data: /* buffer, stream, or file path */,
})
)
.then(() => { console.log('Upload complete'); }, console.log);
侵入性
一个 install 函数导出。 当使用 B2 构造器功能被调用时,它将在其原型上安装两个包装:
authorize被包裹起来。 从响应中提取出推荐的部分大小,并与B2客户对象相关.uploadAny被包裹起来。 选项对象的默认值partSize属性设置为建议小于authorize发现包裹.
这简化了正确使用 uploadAny 函数,因为推荐的部件大小无需绕行您的应用程序.
const B2 = require('backblaze-b2');
require('@gideo-llc/backblaze-b2-upload-any').install(B2);
const b2 = new B2({
applicationKeyId: '...',
applicationKey: '...',
});
b2.authorize()
.then(() =>
b2.uploadAny({
bucketId: '...',
fileName: 'foo',
data: /* buffer, stream, or file path */,
})
)
.then(() => { console.log('Upload complete'); }, console.log);
特性介绍
上传令牌管理
B2需要针对每个同时上传请求分别提供上传URL和授权令牌;重用当前被未解决请求使用的令牌将返回400个错误. 此外,一个符号可能随时会停止工作,服务器会发出503个错误的信号.
此函数通过采取任何适当的动作并重试失败的请求,自动处理这些预期的失败情景.
在引擎盖下,每个桶都有上传URL/token对和每个未完成的大文件上传的队列. 当一个新的上传请求开始时,会从这个缓冲器中去掉一个令牌(或者如果队列是空的会获得一个新的令牌). 当请求成功完成时,该请求所用的符号被排列,以便未来的请求可以再使用. 如果上传请求因舱位太繁忙而失败,则该令牌被丢弃,并在从队列中获取了另一个令牌(或者如果队列是空的,则从B2中获取)后重新测试请求.
使用此机制, 令牌池会自动增大, 以满足您的应用的货币需求 .
流上传
上传文件时,数据可以作为流提供. 上传功能的使用在使用流时完全相同.
由于上传请求由于繁忙的吊舱而经常需要重审,一些流数据可能在内存中被缓冲. 详见下一节.
自动大文件上传
如果来自任何来源的上传(流,缓冲,或文件)大于B2推荐的"大文件"阈值,客户端将自动使用大文件API来将内容上传成片. 这一过程对呼叫者来说是透明的.
如果源是一个流,请注意大文件上传的部分必须被保存在内存中,以便于当一个吊舱太忙时进行重试. (在上传缓冲器时,此库不会分配额外的缓冲;在上传由本地路径指定的文件时,内容会被直接流到服务器. )
以下属性用于控制大文件上传的方面:
concurrency: 同时上传要执行的部分的数目。 默认为 1 .largeFileThreshold: 使用大文件API所需的大小(以字节计). 小于此的文件在单个中上传b2_upload_file请求.partSize:每个上传部分的大小(以字节计). B2允许部分大小在5MB到5GB之间. B2 返回的推荐部件大小默认值authorizeAPI电话. (注意这一数值与B2文件中的建议相同 -- -- 目前为100MB。) 如果您将执行许多并行流上传或设置concurrency相当高, 考虑指定更小的值来避免在 JavaScript 堆积中耗尽可用的内存
注意B2只接受最多一万个部件的单个文件. 若为 contentLength / partSize > 10000 然后上传最终会失败.
API 密码
此模块导出单个函数 uploadAny,必须用 B2 对象作为上下文。 此功能可附在原型 backblaze-b2 客户端.
上传任何( 选项)
根据指定的选项上传新文件. options 为具有下列属性的对象:
bucketId: 字符串, 需要 。 要上传的桶ID .concurrency: 数. 同步上传可以同时执行的部分的数量. 只用于大文件模式 。 默认为 1 .contentType:弦乐. B2对象上记录的MIME类型. 默认为b2/x-auto。 。 。 .data:缓冲,可读流,或作弦. 要求.- 如果缓冲器,缓冲器的全部内容会被上传. 用缓冲器
.subarray()方法,如果缓冲器的分节应当上传. - 如果一个可读流,生成的所有数据都会被上传. 流不能以对象模式存在 .
- 如果一个字符串,则该字符串命名的本地文件会被上传. (要上传字符串的内容,请使用
Buffer.from(string, encoding)函数。)
- 如果缓冲器,缓冲器的全部内容会被上传. 用缓冲器
fileName: 字符串, 需要 。 在 B2 中创建对象的名称 .largeFileThreshold: 数. 启用大文件模式的字节大小 。 一定超过partSize默认为partSize * 2。 。 。 .partSize: 数目,需要。 以字节上传每个部分的大小 。 只用于大文件模式 。 一定在500万(5MB)到5000万(5GB)之间.
返回对 JSON 解码反应机构的许诺 b2_upload_file 或者说 b2_finish_large_file API呼叫,取决于使用哪种机制.