Class HttpContentRange

Describes which subset of a set of elements a response contains.

Index

Constructors

Properties

from? length? to? unit

Methods

Constructors

constructor

new HttpContentRange(
    unit: string,
    from?: number,
    to?: number,
    length?: number,
): HttpContentRange
Creates a new content range.
Parameters
- unit: string
  The unit the range is expressed in, e.g. elements.
- Optionalfrom: number
  The index at which the data starts.
- Optionalto: number
  The index at which the data stops.
- Optionallength: number
  The total number of elements available on the server; undefined if unknown.
Returns HttpContentRange
- Defined in http/HttpContentRange.ts:14

Properties

`Optional` `Readonly`from

from?: number

The index at which the data starts.

`Optional` `Readonly`length

length?: number

The total number of elements available on the server; undefined if unknown.

`Optional` `Readonly`to

to?: number

The index at which the data stops.

`Readonly`unit

unit: string

The unit the range is expressed in, e.g. elements.

Methods

`Static`from

from(response: Response): HttpContentRange | undefined
Extracts the content range from a Response.
Parameters
- response: Response
Returns HttpContentRange | undefined
The content range; undefined if the response has no (valid) HttpHeader.ContentRange header.
- Defined in http/HttpContentRange.ts:27