Interface HttpOptions

Represents the options passed to the constructor of HttpReader.

interface HttpOptions {
    combineSizeEocd?: boolean;
    forceRangeRequests?: boolean;
    headers?: Iterable<[string, string], any, any> | Map<string, string>;
    preventHeadRequest?: boolean;
    useRangeHeader?: boolean;
    useXHR?: boolean;
}

Hierarchy (View Summary)

Properties

combineSizeEocd? forceRangeRequests? headers? preventHeadRequest? useRangeHeader? useXHR?

Properties

OptionalcombineSizeEocd

combineSizeEocd?: boolean

true to use Range: bytes=-22 on the first request and cache the EOCD, make sure beforehand that the server supports a suffix range request.

Default Value

false

OptionalforceRangeRequests

forceRangeRequests?: boolean

true to always use Range headers when fetching data.

Default Value

false

Optionalheaders

headers?: Iterable<[string, string], any, any> | Map<string, string>

The HTTP headers.

OptionalpreventHeadRequest

preventHeadRequest?: boolean

true to prevent using HEAD HTTP request in order the get the size of the content. false to explicitly use HEAD, this is useful in case of CORS where Access-Control-Expose-Headers: Content-Range is not returned by the server.

Default Value

false

OptionaluseRangeHeader

useRangeHeader?: boolean

true to use Range headers when fetching data from servers returning Accept-Ranges headers.

Default Value

false

OptionaluseXHR

useXHR?: boolean

true to rely XMLHttpRequest instead of fetch to fetch data.

Default Value

false

Settings

Member Visibility

On This Page

Properties