type-is

Functions

• DEFAULT_LOOKUP()
• DEFAULT_PARAMETER_VALUE()
• hasBody()
• match()
• normalize()

Classes

• TypeIs

  • contentType()
  • is()
  • request()

Interfaces

• NormalizeOptions

  • lookup
• RequestLike

  • headers
• TypeIsOptions

  • parameterValue

Type Aliases

• ParameterValue

function DEFAULT_LOOKUP

DEFAULT_LOOKUP: (value: string) => string | string[] | undefined;

• The default behavior of lookup handles only a few common shorthands.

function DEFAULT_PARAMETER_VALUE

DEFAULT_PARAMETER_VALUE: (key: string, value: string) => string;

• Normalize a parameter value for comparison.

function hasBody

hasBody: (req: RequestLike) => boolean;

• Check if a request has a request body. A request with a body must either have transfer-encoding or content-length headers set.

function match

match: (expected: string) => (actual: string) => boolean;

• Compile an expected mime type into a reusable matcher.

function normalize

normalize: (value: string, options?: NormalizeOptions) => string | string[];

• Normalize MIME type by:

  - If the string contains a /, then it is returned as the type. - If the string starts with + (so it is a +suffix shorthand like +json), then it is expanded to contain the complete wildcard notation of *\/*+suffix. - Else the string is assumed to be a file extension and the mapped media type is returned, or the original input if there is no mapping.

type ParameterValue

type ParameterValue = (key: string, value: string) => string;