HttpClient
@raizfc/contracts / HttpClient
Interface: HttpClient
Defined in: client.ts:15
Methods
delete()
delete<
T>(path,body?,options?):Promise<ApiResponse<T>>
Defined in: client.ts:32
Type Parameters
T
T extends object
Parameters
path
string
body?
unknown
options?
Readonly<{ authRequired?: boolean; headers?: Readonly<Record<string, string>>; idempotencyKey?: string; }>
Returns
Promise<ApiResponse<T>>
get()
get<
T>(path,query?):Promise<ApiResponse<T>>
Defined in: client.ts:16
Type Parameters
T
T extends object
Parameters
path
string
query?
Readonly<Record<string, QueryParamValue | readonly QueryParamValue[] | undefined>>
Returns
Promise<ApiResponse<T>>
patch()
patch<
T>(path,body?,options?):Promise<ApiResponse<T>>
Defined in: client.ts:22
Type Parameters
T
T extends object
Parameters
path
string
body?
unknown
options?
Readonly<{ authRequired?: boolean; headers?: Readonly<Record<string, string>>; idempotencyKey?: string; }>
Returns
Promise<ApiResponse<T>>
post()
post<
T>(path,body?,options?):Promise<ApiResponse<T>>
Defined in: client.ts:17
Type Parameters
T
T extends object
Parameters
path
string
body?
unknown
options?
Readonly<{ authRequired?: boolean; headers?: Readonly<Record<string, string>>; idempotencyKey?: string; }>
Returns
Promise<ApiResponse<T>>
put()
put<
T>(path,body?,options?):Promise<ApiResponse<T>>
Defined in: client.ts:27
Type Parameters
T
T extends object
Parameters
path
string
body?
unknown
options?
Readonly<{ authRequired?: boolean; headers?: Readonly<Record<string, string>>; idempotencyKey?: string; }>
Returns
Promise<ApiResponse<T>>