Skip to main content

Class: R2Publisher

Publishes to Cloudflare R2.

Set CF_R2_ACCESS_KEY_ID and CF_R2_SECRET_ACCESS_KEY environment variables to the R2 API token credentials (see https://developers.cloudflare.com/r2/api/s3/tokens/).

Extends​

  • BaseS3Publisher

Constructors​

Constructor​

new R2Publisher(context, info): R2Publisher

Parameters​

context​

PublishContext

info​

R2Options

Returns​

R2Publisher

Overrides​

BaseS3Publisher.constructor

Properties​

context​

protected readonly context: PublishContext

Inherited from​

BaseS3Publisher.context

providerName​

readonly providerName: "r2" = "r2"

Overrides​

BaseS3Publisher.providerName

Methods​

createProgressBar()​

protected createProgressBar(fileName, size): ProgressBar | null

Parameters​

fileName​

string

size​

number

Returns​

ProgressBar | null

Inherited from​

BaseS3Publisher.createProgressBar

createReadStreamAndProgressBar()​

protected createReadStreamAndProgressBar(file, fileStat, progressBar, reject): ReadableStream

Parameters​

file​

string

fileStat​

Stats

progressBar​

ProgressBar | null

reject​

(error) => void

Returns​

ReadableStream

Inherited from​

BaseS3Publisher.createReadStreamAndProgressBar

getBucketName()​

protected getBucketName(): string

Returns​

string

Overrides​

BaseS3Publisher.getBucketName

getS3UploadConfig()​

getS3UploadConfig(): S3UploadConfig

Returns​

S3UploadConfig

Overrides​

BaseS3Publisher.getS3UploadConfig

getUploadExtraParams()​

getUploadExtraParams(): S3UploadExtraParams

Returns​

S3UploadExtraParams

Overrides​

BaseS3Publisher.getUploadExtraParams

toString()​

toString(): string

Returns​

string

Inherited from​

BaseS3Publisher.toString

upload()​

upload(task): Promise<any>

Parameters​

task​

UploadTask

Returns​

Promise<any>

Inherited from​

BaseS3Publisher.upload

checkAndResolveOptions()​

static checkAndResolveOptions(options, channelFromAppVersion, errorIfCannot): Promise<void>

Parameters​

options​

R2Options

channelFromAppVersion​

string | null

errorIfCannot​

boolean

Returns​

Promise<void>