acceptsEncodings | /deps.ts | oak@v12.2.0

function acceptsEncodings

import { acceptsEncodings } from "https://dotland.deno.dev/x/oak@v12.2.0/deps.ts";

acceptsEncodings(request: Request): string[]

Returns an array of content encodings accepted by the request, in order of preference. If there are no encoding supplied in the request, then ["*"] is returned, implying any encoding is accepted.

acceptsEncodings(request: Request, ...encodings: string[]): string | undefined

For a given set of content encodings, return the best match accepted in the request. If no content encodings match, then the function returns undefined.

Returns an array of content encodings accepted by the request, in order of preference. If there are no encoding supplied in the request, then ["*"] is returned, implying any encoding is accepted.

Examples

Example 1

import { acceptsEncodings } from "https://deno.land/std@$STD_VERSION/http/negotiation.ts";

const req = new Request("https://example.com/", {
  headers: { "accept-encoding": "deflate, gzip;q=1.0, *;q=0.5" },
});

acceptsEncodings(req); // ["deflate", "gzip", "*"]

Parameters

request: Request

Returns

string[]

For a given set of content encodings, return the best match accepted in the request. If no content encodings match, then the function returns undefined.

NOTE: You should always supply identity as one of the encodings to ensure that there is a match when the Accept-Encoding header is part of the request.

Examples

Example 1

import { acceptsEncodings } from "https://deno.land/std@$STD_VERSION/http/negotiation.ts";

const req = new Request("https://example.com/", {
  headers: { "accept-encoding": "deflate, gzip;q=1.0, *;q=0.5" },
});

acceptsEncodings(req, "gzip", "identity"); // "gzip"

Parameters

request: Request

...encodings: string[]

Returns

string | undefined