Skip to main content

Interface: GenericServerOptions

Generic (any HTTP(S) server) options. In all publish options File Macros are supported.

Extends

Properties

channel?

readonly optional channel?: string | null

The channel.

Default

latest

provider

readonly provider: "generic"

The provider. Must be generic.

Overrides

PublishConfiguration.provider


publishAutoUpdate?

readonly optional publishAutoUpdate?: boolean

Whether to publish auto update info files.

Auto update relies only on the first provider in the list (you can specify several publishers). Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.

Default

true

Inherited from

PublishConfiguration.publishAutoUpdate


requestHeaders?

readonly optional requestHeaders?: OutgoingHttpHeaders

Any custom request headers

Inherited from

PublishConfiguration.requestHeaders


timeout?

readonly optional timeout?: number | null

Request timeout in milliseconds. (Default is 2 minutes; O is ignored)

Default

120000

Inherited from

PublishConfiguration.timeout


url

readonly url: string

The base url. e.g. https://bucket_name.s3.amazonaws.com.


useMultipleRangeRequest?

readonly optional useMultipleRangeRequest?: boolean

Whether to use multiple range requests for differential update. Defaults to true if url doesn't contain s3.amazonaws.com.