module@warp-drive/core/reactive

Interface RequestLoadingState

Defined in: warp-drive-packages/core/src/signals/request-state.ts:110

Hideconstructor

Lazily consumes the stream of a request, providing a number of reactive properties that can be used to build UIs that respond to the progress of a request.

Methods

abort()

abort(): void;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:330

Aborts the underlying request.

Returns

void

Properties

promise

promise: 
  | Promise<void>
  | null = null;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:177

Resolves once the stream has finished being consumed, or rejects if the request errors. null until first accessed.

bytesLoaded

Get Signature

get bytesLoaded(): number;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:222

The number of bytes loaded so far.

Returns

number

---

completedRatio

Get Signature

get completedRatio(): number;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:296

The ratio (0 to 1) of bytesLoaded to sizeHint, or 0 if no size hint is available.

Returns

number

---

duration

Get Signature

get duration(): number;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:311

The total number of milliseconds elapsed between startTime and endTime.

Returns

number

---

elapsedTime

Get Signature

get elapsedTime(): number;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:288

The number of milliseconds elapsed since the stream started being consumed, using the last packet time (or end time, once complete) as the endpoint.

Returns

number

---

endTime

Get Signature

get endTime(): number;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:238

The performance.now() timestamp at which the stream finished being consumed.

Returns

number

---

error

Get Signature

get error(): 
  | Error
  | null;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:278

The error that occurred while consuming the stream, if any.

Returns

| Error | null

---

isCancelled

Get Signature

get isCancelled(): boolean;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:262

Whether the request was aborted before the stream finished being consumed.

Returns

boolean

---

isComplete

Get Signature

get isComplete(): boolean;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:254

Whether the stream has finished being consumed.

Returns

boolean

---

isErrored

Get Signature

get isErrored(): boolean;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:270

Whether an error occurred while consuming the stream.

Returns

boolean

---

isPending

Get Signature

get isPending(): boolean;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:182

Whether the stream has not yet started being consumed.

Returns

boolean

---

isStarted

Get Signature

get isStarted(): boolean;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:214

Whether the stream has started being consumed but has not yet completed.

Returns

boolean

---

lastPacketTime

Get Signature

get lastPacketTime(): number;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:246

The performance.now() timestamp at which the last chunk of data was received.

Returns

number

---

remainingRatio

Get Signature

get remainingRatio(): number;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:303

The inverse of completedRatio.

Returns

number

---

sizeHint

Get Signature

get sizeHint(): number;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:191

The total size of the response in bytes, if known ahead of time (via a Content-Length header or similar).

Returns

number

---

speed

Get Signature

get speed(): number;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:318

The average download speed in bytes per second.

Returns

number

---

startTime

Get Signature

get startTime(): number;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:230

The performance.now() timestamp at which the stream started being consumed.

Returns

number

---

stream

Get Signature

get stream(): 
  | ReadableStream<any>
  | null;

Defined in: warp-drive-packages/core/src/signals/request-state.ts:200

A readable stream of the response content. Accessing this property begins consumption of the underlying request stream.

Returns

| ReadableStream<any> | null