ApiRequestBuilder | @pagopa/ts-commons

A class for building ApiRequest(s)

Type parameters

M: RequestMethod
P
KH: RequestHeaderKey
Q: string
R
T: ApiRequestTypeForMethod<M, P, KH, Q, R>

Hierarchy

ApiRequestBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new ApiRequestBuilder<M, P, KH, Q, R, T>(_request: T): ApiRequestBuilder<M, P, KH, Q, R, T>

- Defined in src/requests.ts:302
Type parameters
- M: RequestMethod
- P
- KH: RequestHeaderKey
- Q: string
- R
- T: IGetApiRequestType<P, KH, Q, R> | IPostApiRequestType<P, KH, Q, R> | IPutApiRequestType<P, KH, Q, R>
Parameters
- _request: T
Returns ApiRequestBuilder<M, P, KH, Q, R, T>

Methods

get

get(): T

- Defined in src/requests.ts:353
Returns T

withHeaders

withHeaders<P1, KH1>(headers: RequestHeaderProducer<P1, KH1>): ApiRequestBuilder<M, P & P1, KH | KH1, Q, R, ApiRequestTypeForMethod<M, P & P1, KH | KH1, Q, R>>

- Defined in src/requests.ts:386
Adds headers

Type parameters
- P1
- KH1: RequestHeaderKey
Parameters
- headers: RequestHeaderProducer<P1, KH1>
Returns ApiRequestBuilder<M, P & P1, KH | KH1, Q, R, ApiRequestTypeForMethod<M, P & P1, KH | KH1, Q, R>>

withQuery

withQuery<P1, Q1>(query: (params: P1) => Record<Q1, string>): ApiRequestBuilder<M, P & P1, KH, Q | Q1, R, ApiRequestTypeForMethod<M, P & P1, KH, Q | Q1, R>>

- Defined in src/requests.ts:360
Adds query parameters

Type parameters
- P1
- Q1: string
Parameters
- query: (params: P1) => Record<Q1, string>
  - - (params: P1): Record<Q1, string>
    - Parameters
      - params: P1
      Returns Record<Q1, string>
Returns ApiRequestBuilder<M, P & P1, KH, Q | Q1, R, ApiRequestTypeForMethod<M, P & P1, KH, Q | Q1, R>>

withResponseDecoder

withResponseDecoder<R1>(response_decoder: ResponseDecoder<R1>): ApiRequestBuilder<M, P, KH, Q, R1, ApiRequestTypeForMethod<M, P, KH, Q, R1>>

- Defined in src/requests.ts:412
Adds response decoder

Type parameters
- R1
Parameters
- response_decoder: ResponseDecoder<R1>
Returns ApiRequestBuilder<M, P, KH, Q, R1, ApiRequestTypeForMethod<M, P, KH, Q, R1>>

Static ofGet

ofGet(): EmptyApiRequestBuilder<"get", {}, never, never, never>

- Defined in src/requests.ts:307
Creates a new empty request with the GET method.

Returns EmptyApiRequestBuilder<"get", {}, never, never, never>

Static ofPost

ofPost(): EmptyApiRequestBuilder<"post", {}, "Content-Type", never, never>

- Defined in src/requests.ts:321
Creates a new empty request with the POST method.

Returns EmptyApiRequestBuilder<"post", {}, "Content-Type", never, never>

Static ofPut

ofPut(): EmptyApiRequestBuilder<"put", {}, "Content-Type", never, never>

- Defined in src/requests.ts:339
Creates a new empty request with the PUT method.

Returns EmptyApiRequestBuilder<"put", {}, "Content-Type", never, never>

Generated using TypeDoc