Class HttpClient

Default http client implementation of Zibri.

Implements

HttpClientInterface

Index

Constructors

constructor

Methods

delete get patch post put request

Constructors

constructor

new HttpClient(
parser: ParserInterface,
validationService: ValidationServiceInterface,
): HttpClient
Parameters
- parser: ParserInterface
- validationService: ValidationServiceInterface
Returns HttpClient
- Defined in src/http-client/http-client.ts:45

Methods

delete

delete<
    T extends object,
    QueryParamsObject extends
        Record<string, unknown> = Record<string, string | undefined>,
    HeaderParamsObject extends
        Record<string, HttpClientHeaderValue> = Partial<
        Record<KnownHeader, HttpClientHeaderValue>,
    >,
    ResponseHeaderMetaInputObject extends
        Record<string, HeaderParamMetadataInput> = Record<
        string,
        HeaderParamMetadataInput,
    >,
    BodyType extends JSON
    | FORM_DATA = JSON,
    IsArray extends boolean = false,
>(
    url: string,
    options?: HttpOptionsInput<
        T,
        QueryParamsObject,
        HeaderParamsObject,
        ResponseHeaderMetaInputObject,
        BodyType,
        IsArray,
    >,
): Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>
Sends a http delete request.
Type Parameters
- T extends object
- QueryParamsObject extends Record<string, unknown> = Record<string, string | undefined>
- HeaderParamsObject extends Record<string, HttpClientHeaderValue> = Partial<Record<KnownHeader, HttpClientHeaderValue>>
- ResponseHeaderMetaInputObject extends Record<string, HeaderParamMetadataInput> = Record<string, HeaderParamMetadataInput>
- BodyType extends JSON | FORM_DATA = JSON
- IsArray extends boolean = false
Parameters
- url: string
- options: HttpOptionsInput<
      T,
      QueryParamsObject,
      HeaderParamsObject,
      ResponseHeaderMetaInputObject,
      BodyType,
      IsArray,
  > = {}
Returns Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>
Implementation of HttpClientInterface.delete
- Defined in src/http-client/http-client.ts:146

get

get<
    T extends object,
    QueryParamsObject extends
        Record<string, unknown> = Record<string, string | undefined>,
    HeaderParamsObject extends
        Record<string, HttpClientHeaderValue> = Partial<
        Record<KnownHeader, HttpClientHeaderValue>,
    >,
    ResponseHeaderMetaInputObject extends
        Record<string, HeaderParamMetadataInput> = Record<
        string,
        HeaderParamMetadataInput,
    >,
    BodyType extends JSON
    | FORM_DATA = JSON,
    IsArray extends boolean = false,
>(
    url: string,
    options?: HttpOptionsInput<
        T,
        QueryParamsObject,
        HeaderParamsObject,
        ResponseHeaderMetaInputObject,
        BodyType,
        IsArray,
    >,
): Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>
Sends a http get request.
Type Parameters
- T extends object
- QueryParamsObject extends Record<string, unknown> = Record<string, string | undefined>
- HeaderParamsObject extends Record<string, HttpClientHeaderValue> = Partial<Record<KnownHeader, HttpClientHeaderValue>>
- ResponseHeaderMetaInputObject extends Record<string, HeaderParamMetadataInput> = Record<string, HeaderParamMetadataInput>
- BodyType extends JSON | FORM_DATA = JSON
- IsArray extends boolean = false
Parameters
- url: string
- options: HttpOptionsInput<
      T,
      QueryParamsObject,
      HeaderParamsObject,
      ResponseHeaderMetaInputObject,
      BodyType,
      IsArray,
  > = {}
Returns Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>
Implementation of HttpClientInterface.get
- Defined in src/http-client/http-client.ts:78

patch

patch<
    T extends object,
    QueryParamsObject extends
        Record<string, unknown> = Record<string, string | undefined>,
    HeaderParamsObject extends
        Record<string, HttpClientHeaderValue> = Partial<
        Record<KnownHeader, HttpClientHeaderValue>,
    >,
    ResponseHeaderMetaInputObject extends
        Record<string, HeaderParamMetadataInput> = Record<
        string,
        HeaderParamMetadataInput,
    >,
    BodyType extends JSON
    | FORM_DATA = JSON,
    IsArray extends boolean = false,
>(
    url: string,
    body: unknown,
    options?: HttpOptionsInput<
        T,
        QueryParamsObject,
        HeaderParamsObject,
        ResponseHeaderMetaInputObject,
        BodyType,
        IsArray,
    >,
): Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>
Sends a http patch request.
Type Parameters
- T extends object
- QueryParamsObject extends Record<string, unknown> = Record<string, string | undefined>
- HeaderParamsObject extends Record<string, HttpClientHeaderValue> = Partial<Record<KnownHeader, HttpClientHeaderValue>>
- ResponseHeaderMetaInputObject extends Record<string, HeaderParamMetadataInput> = Record<string, HeaderParamMetadataInput>
- BodyType extends JSON | FORM_DATA = JSON
- IsArray extends boolean = false
Parameters
- url: string
- body: unknown
- options: HttpOptionsInput<
      T,
      QueryParamsObject,
      HeaderParamsObject,
      ResponseHeaderMetaInputObject,
      BodyType,
      IsArray,
  > = {}
Returns Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>
Implementation of HttpClientInterface.patch
- Defined in src/http-client/http-client.ts:123

post

post<
    T extends object,
    QueryParamsObject extends
        Record<string, unknown> = Record<string, string | undefined>,
    HeaderParamsObject extends
        Record<string, HttpClientHeaderValue> = Partial<
        Record<KnownHeader, HttpClientHeaderValue>,
    >,
    ResponseHeaderMetaInputObject extends
        Record<string, HeaderParamMetadataInput> = Record<
        string,
        HeaderParamMetadataInput,
    >,
    BodyType extends JSON
    | FORM_DATA = JSON,
    IsArray extends boolean = false,
>(
    url: string,
    body: unknown,
    options?: HttpOptionsInput<
        T,
        QueryParamsObject,
        HeaderParamsObject,
        ResponseHeaderMetaInputObject,
        BodyType,
        IsArray,
    >,
): Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>
Sends a http post request.
Type Parameters
- T extends object
- QueryParamsObject extends Record<string, unknown> = Record<string, string | undefined>
- HeaderParamsObject extends Record<string, HttpClientHeaderValue> = Partial<Record<KnownHeader, HttpClientHeaderValue>>
- ResponseHeaderMetaInputObject extends Record<string, HeaderParamMetadataInput> = Record<string, HeaderParamMetadataInput>
- BodyType extends JSON | FORM_DATA = JSON
- IsArray extends boolean = false
Parameters
- url: string
- body: unknown
- options: HttpOptionsInput<
      T,
      QueryParamsObject,
      HeaderParamsObject,
      ResponseHeaderMetaInputObject,
      BodyType,
      IsArray,
  > = {}
Returns Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>
Implementation of HttpClientInterface.post
- Defined in src/http-client/http-client.ts:55

put

put<
    T extends object,
    QueryParamsObject extends
        Record<string, unknown> = Record<string, string | undefined>,
    HeaderParamsObject extends
        Record<string, HttpClientHeaderValue> = Partial<
        Record<KnownHeader, HttpClientHeaderValue>,
    >,
    ResponseHeaderMetaInputObject extends
        Record<string, HeaderParamMetadataInput> = Record<
        string,
        HeaderParamMetadataInput,
    >,
    BodyType extends JSON
    | FORM_DATA = JSON,
    IsArray extends boolean = false,
>(
    url: string,
    body: unknown,
    options?: HttpOptionsInput<
        T,
        QueryParamsObject,
        HeaderParamsObject,
        ResponseHeaderMetaInputObject,
        BodyType,
        IsArray,
    >,
): Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>
Sends a http put request.
Type Parameters
- T extends object
- QueryParamsObject extends Record<string, unknown> = Record<string, string | undefined>
- HeaderParamsObject extends Record<string, HttpClientHeaderValue> = Partial<Record<KnownHeader, HttpClientHeaderValue>>
- ResponseHeaderMetaInputObject extends Record<string, HeaderParamMetadataInput> = Record<string, HeaderParamMetadataInput>
- BodyType extends JSON | FORM_DATA = JSON
- IsArray extends boolean = false
Parameters
- url: string
- body: unknown
- options: HttpOptionsInput<
      T,
      QueryParamsObject,
      HeaderParamsObject,
      ResponseHeaderMetaInputObject,
      BodyType,
      IsArray,
  > = {}
Returns Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>
Implementation of HttpClientInterface.put
- Defined in src/http-client/http-client.ts:100

request

request<
    T extends object,
    QueryParamsObject extends Record<string, unknown>,
    HeaderParamsObject extends Record<string, HttpClientHeaderValue>,
    ResponseHeaderMetaInputObject extends
        Record<string, HeaderParamMetadataInput>,
    BodyType extends JSON
    | FORM_DATA,
    IsArray extends boolean,
>(
    method: HttpMethod,
    url: string,
    requestBody: unknown,
    options:
        | Partial<
            HttpOptions<
                T,
                QueryParamsObject,
                HeaderParamsObject,
                ResponseHeaderMetaInputObject,
                BodyType,
                IsArray,
            >,
        >
        | undefined,
): Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>
Sends a request with the given data.
Type Parameters
- T extends object
- QueryParamsObject extends Record<string, unknown>
- HeaderParamsObject extends Record<string, HttpClientHeaderValue>
- ResponseHeaderMetaInputObject extends Record<string, HeaderParamMetadataInput>
- BodyType extends JSON | FORM_DATA
- IsArray extends boolean
Parameters
- method: HttpMethod
- url: string
- requestBody: unknown
- options:
      | Partial<
          HttpOptions<
              T,
              QueryParamsObject,
              HeaderParamsObject,
              ResponseHeaderMetaInputObject,
              BodyType,
              IsArray,
          >,
      >
      | undefined
Returns Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>
Implementation of HttpClientInterface.request
- Defined in src/http-client/http-client.ts:168

Class HttpClient

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns HttpClient

Methods

delete

Type Parameters

Parameters

Returns Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>

get

Type Parameters

Parameters

Returns Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>

patch

Type Parameters

Parameters

Returns Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>

post

Type Parameters

Parameters

Returns Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>

put

Type Parameters

Parameters

Returns Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>

request

Type Parameters

Parameters

Returns Promise<
    HttpClientResponseForBodyType<
        T,
        HeaderMetaObjectToParamsObject<
            HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
        >,
        BodyType,
        IsArray,
    >,
>

Settings

On This Page

Class HttpClient

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns HttpClient

Methods

delete

Type Parameters

Parameters

Returns Promise< HttpClientResponseForBodyType< T, HeaderMetaObjectToParamsObject< HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>, >, BodyType, IsArray, >,>

get

Type Parameters

Parameters

Returns Promise< HttpClientResponseForBodyType< T, HeaderMetaObjectToParamsObject< HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>, >, BodyType, IsArray, >,>

patch

Type Parameters

Parameters

Returns Promise< HttpClientResponseForBodyType< T, HeaderMetaObjectToParamsObject< HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>, >, BodyType, IsArray, >,>

post

Type Parameters

Parameters

Returns Promise< HttpClientResponseForBodyType< T, HeaderMetaObjectToParamsObject< HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>, >, BodyType, IsArray, >,>

put

Type Parameters

Parameters

Returns Promise< HttpClientResponseForBodyType< T, HeaderMetaObjectToParamsObject< HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>, >, BodyType, IsArray, >,>

request

Type Parameters

Parameters

Returns Promise< HttpClientResponseForBodyType< T, HeaderMetaObjectToParamsObject< HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>, >, BodyType, IsArray, >,>

Settings

On This Page

Returns Promise<
HttpClientResponseForBodyType<
T,
HeaderMetaObjectToParamsObject<
HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
>,
BodyType,
IsArray,
>,
>

Returns Promise<
HttpClientResponseForBodyType<
T,
HeaderMetaObjectToParamsObject<
HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
>,
BodyType,
IsArray,
>,
>

Returns Promise<
HttpClientResponseForBodyType<
T,
HeaderMetaObjectToParamsObject<
HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
>,
BodyType,
IsArray,
>,
>

Returns Promise<
HttpClientResponseForBodyType<
T,
HeaderMetaObjectToParamsObject<
HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
>,
BodyType,
IsArray,
>,
>

Returns Promise<
HttpClientResponseForBodyType<
T,
HeaderMetaObjectToParamsObject<
HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
>,
BodyType,
IsArray,
>,
>

Returns Promise<
HttpClientResponseForBodyType<
T,
HeaderMetaObjectToParamsObject<
HeaderMetaInputObjectToMetaObject<ResponseHeaderMetaInputObject>,
>,
BodyType,
IsArray,
>,
>