Class Future

public
Extends: Promise
Defined in: ../request/src/-private/types.ts:34
Module: @ember-data/request

A Future is a Promise which resolves to a StructuredDocument while providing the ability to abort the underlying request, getStream the response before the outer promise resolves;

Show:

abort (reason) Void public

Module: @ember-data/request

Defined in ../packages/request/src/-private/types.ts:45

reason
String

optional reason for aborting the request

returns
Void

Cancel this request by firing the AbortController's signal.

getStream Promise<ReadableStream | null> public

Module: @ember-data/request

Defined in ../packages/request/src/-private/types.ts:54

returns
Promise<ReadableStream | null>

Get the response stream, if any, once made available.

onFinalize (cb) public

Module: @ember-data/request

Defined in ../packages/request/src/-private/types.ts:63

cb

the callback to run

returns

void

Run a callback when this request completes. Use sparingly, mostly useful for instrumentation and infrastructure.