requests | @pagopa/ts-commons

Index

Classes

ApiRequestBuilder

Interfaces

Functions

Type aliases

AddResponseType

AddResponseType<T, S, A>: T extends IGetApiRequestType<infer P1, infer H1, infer Q1, infer R1> ? IGetApiRequestType<P1, H1, Q1, R1 | IResponseType<S, A>> : T extends IPostApiRequestType<infer P2, infer H2, infer Q2, infer R2> ? IPostApiRequestType<P2, H2, Q2, R2 | IResponseType<S, A>> : T extends IPutApiRequestType<infer P3, infer H3, infer Q3, infer R3> ? IPutApiRequestType<P3, H3, Q3, R3 | IResponseType<S, A>> : T extends IDeleteApiRequestType<infer P4, infer H4, infer Q4, infer R4> ? IDeleteApiRequestType<P4, H4, Q4, R4 | IResponseType<S, A>> : never

Adds the status S with response type A to the responses of the request

Type parameters

T
S: number
A

ApiRequestType

ApiRequestType<P, KH, Q, R>: IGetApiRequestType<P, KH, Q, R> | IPostApiRequestType<P, KH, Q, R> | IPutApiRequestType<P, KH, Q, R> | IDeleteApiRequestType<P, KH, Q, R>

The union of the possible ApiRequest types

Type parameters

P
KH: RequestHeaderKey
Q: string
R

ApiRequestTypeForMethod

ApiRequestTypeForMethod<M, P, KH, Q, R>: M extends "get" ? IGetApiRequestType<P, KH, Q, R> : M extends "post" ? IPostApiRequestType<P, KH, Q, R> : M extends "put" ? IPutApiRequestType<P, KH, Q, R> : never

Type parameters

M: RequestMethod
P
KH: RequestHeaderKey
Q: string
R

BasicResponseHeaderKey

BasicResponseType

BasicResponseType<R, H>: IResponseType<200, R, H> | IResponseType<404, string, H> | IResponseType<500, string, H>

A basic set of responses where the 200 status corresponds to a payload of type R and 404 and 500 to an Error

Type parameters

R
H: string = never

EmptyApiRequestBuilder

EmptyApiRequestBuilder<M, P, KH, Q, R>: ApiRequestBuilder<M, P, KH, Q, R, ApiRequestTypeForMethod<M, P, KH, Q, R>>

Type parameters

M: RequestMethod
P = {}
KH: RequestHeaderKey = never
Q: string = never
R = never

MapResponseType

MapResponseType<T, S, B>: T extends IGetApiRequestType<infer P1, infer H1, infer Q1, infer R1> ? IGetApiRequestType<P1, H1, Q1, MapTypeInApiResponse<R1, S, B>> : T extends IPostApiRequestType<infer P2, infer H2, infer Q2, infer R2> ? IPostApiRequestType<P2, H2, Q2, MapTypeInApiResponse<R2, S, B>> : T extends IPutApiRequestType<infer P3, infer H3, infer Q3, infer R3> ? IPutApiRequestType<P3, H3, Q3, MapTypeInApiResponse<R3, S, B>> : T extends IDeleteApiRequestType<infer P4, infer H4, infer Q4, infer R4> ? IDeleteApiRequestType<P4, H4, Q4, MapTypeInApiResponse<R4, S, B>> : never

Changes the response with status S to have type B

Type parameters

T
S: number
B

OmitStatusFromResponse

OmitStatusFromResponse<T, S>: T extends IResponseType<S, any> ? never : T

Removes a status from the union of IResponseType(s)

Type parameters

T
S: number

ReplaceRequestParams

ReplaceRequestParams<T, P>: T extends IGetApiRequestType<infer _P1, infer H1, infer Q1, infer R1> ? IGetApiRequestType<P, H1, Q1, R1> : T extends IPostApiRequestType<infer _P2, infer H2, infer Q2, infer R2> ? IPostApiRequestType<P, H2, Q2, R2> : T extends IPutApiRequestType<infer _P3, infer H3, infer Q3, infer R3> ? IPutApiRequestType<P, H3, Q3, R3> : T extends IDeleteApiRequestType<infer _P4, infer H4, infer Q4, infer R4> ? IDeleteApiRequestType<P, H4, Q4, R4> : never

Replaces the parameters of the request T with the type P

Type parameters

RequestHeaderKey

Describes the possible header keys of a request

RequestHeaderProducer

RequestHeaderProducer<P, KH>: (params: P) => RequestHeaders<KH>

Generates a set of headers with certain keys (KH) from a parameters object of type P.

Type parameters

P
KH: RequestHeaderKey

Type declaration

- (params: P): RequestHeaders<KH>
- Parameters
  - params: P
  Returns RequestHeaders<KH>

RequestHeaders

RequestHeaders<HS>: {[ key in HS]: string }

Describes a set of headers whose keys are of type RequestHeaderKey

Type parameters

HS: RequestHeaderKey

RequestMethod

RequestMethod: "get" | "post" | "put" | "delete"

Describes the possible methods of a request

RequestParams

RequestParams<T>: T extends IGetApiRequestType<infer P1, infer _H1, infer _Q1, infer _R1> ? P1 : T extends IPostApiRequestType<infer P2, infer _H2, infer _Q2, infer _R2> ? P2 : T extends IPutApiRequestType<infer P3, infer _H3, infer _Q3, infer _R3> ? P3 : T extends IDeleteApiRequestType<infer P4, infer _H4, infer _Q4, infer _R4> ? P4 : never

The parameters of the request T

Type parameters

RequestQuery

RequestQuery<K>: Record<K, string>

Describes the query params for this request

Type parameters

K: string

ResponseDecoder

ResponseDecoder<R>: (response: Response) => Promise<t.Validation<R> | undefined>

A function that generates a typed representation of a response. It should return undefined in case the response cannot be decoded (e.g. in case of a parsing error).

Type parameters

Type declaration

- (response: Response): Promise<t.Validation<R> | undefined>
- Parameters
  - response: Response
  Returns Promise<t.Validation<R> | undefined>

ResponseHeaders

ResponseHeaders<H>: {[ key in BasicResponseHeaderKey | H]: string }

Type parameters

H: string = never

TypeOfApiResponseStatus

TypeOfApiResponseStatus<T>: TypeofApiResponse<T> extends IResponseType<infer S, any> ? S : never

A union type of the Response statuses of an ApiRequestType

Type parameters

TypeofApiCall

TypeofApiCall<T>: (params: TypeofApiParams<T>) => Promise<t.Validation<TypeofApiResponse<T>>>

The type of the method that runs an ApiRequestType

Type parameters

Type declaration

- (params: TypeofApiParams<T>): Promise<t.Validation<TypeofApiResponse<T>>>
- Parameters
  - params: TypeofApiParams<T>
  Returns Promise<t.Validation<TypeofApiResponse<T>>>

TypeofApiParams

TypeofApiParams<T>: T extends ApiRequestType<infer P, infer _KH, infer _Q, infer _R> ? P : never

The type of the Params of an ApiRequestType

Type parameters

TypeofApiResponse

TypeofApiResponse<T>: T extends ApiRequestType<infer _P, infer _KH, infer _Q, infer R> ? R : never

The type of the Response of an ApiRequestType

Type parameters

Functions

Const ApiHeaderJson

ApiHeaderJson(params: {}): RequestHeaders<"Content-Type">

- Defined in src/requests.ts:533
An header producer that sets the Content-Type to application/json

Parameters
- params: {}
Returns RequestHeaders<"Content-Type">

AuthorizationBearerHeaderProducer

AuthorizationBearerHeaderProducer<P>(token: string): RequestHeaderProducer<P, "Authorization">

- Defined in src/requests.ts:660
Returns a RequestHeaderProducer that produces an Authorization header of type "bearer token" with a fixed token value.

Type parameters
- P
Parameters
- token: string
Returns RequestHeaderProducer<P, "Authorization">

ParamAuthorizationBearerHeaderProducer

ParamAuthorizationBearerHeaderProducer<P>(): RequestHeaderProducer<P, "Authorization">

- Defined in src/requests.ts:646
Returns a RequestHeaderProducer that produces an Authorization header of type "bearer token" taking the value from the "token" parameter of each request.

Type parameters
- P: { token: string }
Returns RequestHeaderProducer<P, "Authorization">

basicErrorResponseDecoder

basicErrorResponseDecoder<S, H>(status: S): ResponseDecoder<IResponseType<S, string, H>>

- Defined in src/requests.ts:577
A basic ResponseDecoder that returns an Error with the status text if the response status is S.

Type parameters
- S: number
- H: string = never
Parameters
- status: S
Returns ResponseDecoder<IResponseType<S, string, H>>

basicResponseDecoder

basicResponseDecoder<R, O, H>(type: t.Type<R, O>, preprocessor?: (i: any) => any): ResponseDecoder<BasicResponseType<R, H>>

- Defined in src/requests.ts:607
Returns a ResponseDecoder for BasicResponseType

Type parameters
- R
- O = R
- H: string = never
Parameters
- type: t.Type<R, O>
- Optional preprocessor: (i: any) => any
  - - (i: any): any
    - Parameters
      - i: any
      Returns any
Returns ResponseDecoder<BasicResponseType<R, H>>

composeHeaderProducers

composeHeaderProducers<PI, KI, PH, KH>(p0: RequestHeaderProducer<PI, KI>, p1: RequestHeaderProducer<PH, KH>): RequestHeaderProducer<PI & PH, KI | KH>

- Defined in src/requests.ts:55
Composes two RequestHeaderProducer(s)

Type parameters
- PI
- KI: RequestHeaderKey
- PH
- KH: RequestHeaderKey
Parameters
- p0: RequestHeaderProducer<PI, KI>
- p1: RequestHeaderProducer<PH, KH>
Returns RequestHeaderProducer<PI & PH, KI | KH>

composeResponseDecoders

composeResponseDecoders<R1, R2>(d1: ResponseDecoder<R1>, d2: ResponseDecoder<R2>): ResponseDecoder<R1 | R2>

- Defined in src/requests.ts:111
Composes two ResponseDecoder(s)

Type parameters
- R1
- R2
Parameters
- d1: ResponseDecoder<R1>
- d2: ResponseDecoder<R2>
Returns ResponseDecoder<R1 | R2>

constantResponseDecoder

constantResponseDecoder<T, S, H>(status: S, value: T): ResponseDecoder<IResponseType<S, T, H>>

- Defined in src/requests.ts:624
A response decoder that ignores the payload and returns a constant value

Type parameters
- T
- S: number
- H: string = never
Parameters
- status: S
- value: T
Returns ResponseDecoder<IResponseType<S, T, H>>

createFetchRequestForApi

createFetchRequestForApi<P, KH, Q, R>(requestType: ApiRequestType<P, KH, Q, R>, options?: { baseUrl?: string; fetchApi?: typeof __type }): (params: P) => Promise<t.Validation<R>>

- Defined in src/requests.ts:451
Returns an async method that implements the provided ApiRequestType backed by the "fetch" API.

Type parameters
- P
- KH: RequestHeaderKey
- Q: string
- R
Parameters
- requestType: ApiRequestType<P, KH, Q, R>
- options: { baseUrl?: string; fetchApi?: typeof __type } = ...
  - Optional Readonly baseUrl?: string
  - Optional Readonly fetchApi?: typeof __type
Returns (params: P) => Promise<t.Validation<R>>
- - (params: P): Promise<t.Validation<R>>
  - Parameters
    - params: P
    Returns Promise<t.Validation<R>>

ioResponseDecoder

ioResponseDecoder<S, R, O, H>(status: S, type: t.Type<R, O>, preprocessor?: (i: any) => any): ResponseDecoder<IResponseType<S, R, H>>

- Defined in src/requests.ts:546
An io-ts based ResponseDecoder, it checks the response status and the payload against the provided type.

Type parameters
- S: number
- R
- O = R
- H: string = never
Parameters
- status: S
  
  The response status handled by this decoder
- type: t.Type<R, O>
  
  The response type corresponding to the status
- preprocessor: (i: any) => any = ...
  
  A function that takes the object corresponding to the json response as input and returns the processed object (usefull when you want alterate the json body received)
  - - (i: any): any
    - Parameters
      - i: any
      Returns any
Returns ResponseDecoder<IResponseType<S, R, H>>

Generated using TypeDoc

Index

Classes

Interfaces

Type aliases

Functions

Type aliases

AddResponseType

Type parameters

T

S: number

A

ApiRequestType

Type parameters

P

KH: RequestHeaderKey

Q: string

R

ApiRequestTypeForMethod

Type parameters

M: RequestMethod

P

KH: RequestHeaderKey

Q: string

R

BasicResponseHeaderKey

BasicResponseType

Type parameters

R

H: string = never

EmptyApiRequestBuilder

Type parameters

M: RequestMethod

P = {}

KH: RequestHeaderKey = never

Q: string = never

R = never

MapResponseType

Type parameters

T

S: number

B

OmitStatusFromResponse

Type parameters

T

S: number

ReplaceRequestParams

Type parameters

T

P

RequestHeaderKey

RequestHeaderProducer

Type parameters

P

KH: RequestHeaderKey

Type declaration

Parameters

params: P

Returns RequestHeaders<KH>

RequestHeaders

Type parameters

HS: RequestHeaderKey

RequestMethod

RequestParams

Type parameters

T

RequestQuery

Type parameters

K: string

ResponseDecoder

Type parameters

R

Type declaration

Parameters

response: Response

Returns Promise<t.Validation<R> | undefined>

ResponseHeaders

Type parameters

H: string = never

TypeOfApiResponseStatus

Type parameters