IPutApiRequestType | @pagopa/ts-commons

Fully describes a PUT request.

PUT requests require to provide the "Content-Type" header.

Type parameters

P
KH: RequestHeaderKey
Q: string
R

Hierarchy

IBaseApiRequestType<"put", P, KH | "Content-Type", Q, R>
- IPutApiRequestType

Index

Properties

Properties

Readonly body

body: (params: P) => string | FormData

Type declaration

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

Readonly headers

headers: RequestHeaderProducer<P, "Content-Type" | KH>

Readonly method

method: "put"

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