IBaseApiRequestType | @pagopa/ts-commons

Fully describes an API request.

Type parameters

M: RequestMethod

The request method
P

The type of input parameters
H: RequestHeaderKey

The headers that must be defined for this request
Q: string
R

The possible response types for this request

Hierarchy

IBaseApiRequestType

Index

Properties

Properties

Readonly headers

headers: RequestHeaderProducer<P, H>

Readonly method

method: M

Readonly query

query: (params: P) => Record<Q, string>

Type declaration

- (params: P): Record<Q, string>
- Parameters
  - params: P
  Returns Record<Q, string>

Readonly response_decoder

response_decoder: ResponseDecoder<R>

Readonly url

url: (params: P) => string

Type declaration

- (params: P): string
- Parameters
  - params: P
  Returns string

Generated using TypeDoc