Interface IParameterOptionsWithHeadersSource

Options for Parameter decorator, which defines the source of the paremeter as from one or more HTTP request header.

interface IParameterOptionsWithHeadersSource {
    names?: Nilable<string[]>;
    source: Nilable<"headers">;
    transformTo?: Nilable<ParameterDataTransformTo>;
}

Hierarchy

Properties

names?: Nilable<string[]>

One or more header names. If not defined, all headers are taken.

source: Nilable<"headers">

The name of the source.

transformTo?: Nilable<ParameterDataTransformTo>

A custom function, which transforms input data to a new format / type.

Generated using TypeDoc