Documentation / @warp-drive/utilities / handlers / AutoCompress

Class: AutoCompress

Defined in: utilities/src/-private/handlers/auto-compress.ts:180

A request handler that automatically compresses the request body if the request body is a string, array buffer, blob, or form data.

This uses the CompressionStream API

The compression format as well as the kinds of data to compress can be configured using the format and constraints options.

+import { AutoCompress } from '@ember-data/request-utils/handlers';
import Fetch from '@ember-data/request/fetch';
import RequestManager from '@ember-data/request';
import Store from '@ember-data/store';

class AppStore extends Store {
  requestManager = new RequestManager()
    .use([
+       new AutoCompress(),
       Fetch
    ]);
}

AutoCompress

Since

5.5.0

Implements

• Handler

Methods

request()

request<T>(context, next): 
  | Promise<T>
| Future<T>;

Defined in: utilities/src/-private/handlers/auto-compress.ts:193

Method to implement to handle requests. Receives the request context and a nextFn to call to pass-along the request to other handlers.

Type Parameters

T

T

Parameters

context

RequestContext

next

NextFn<T>

Returns

| Promise<T> | Future<T>

Implementation of

Handler.request

Properties

options

options: Required<CompressionOptions> & object;

Defined in: utilities/src/-private/handlers/auto-compress.ts:181

Type declaration

constraints

constraints: Required<Constraints>;

Constructors

Constructor

new AutoCompress(options): AutoCompress;

Defined in: utilities/src/-private/handlers/auto-compress.ts:183

Parameters

options

CompressionOptions = {}

Returns

AutoCompress