RestClient
Defined in: packages/api-client/src/rest/client/RestClient.ts:100
REST client class. Construct once per backend/baseURL; reuse the instance across services.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RestClient(
options?):RestClient
Defined in: packages/api-client/src/rest/client/RestClient.ts:104
Parameters
Section titled “Parameters”options?
Section titled “options?”RestClientOptions = {}
Returns
Section titled “Returns”RestClient
Accessors
Section titled “Accessors”instance
Section titled “instance”Get Signature
Section titled “Get Signature”get instance():
ApisauceInstance
Defined in: packages/api-client/src/rest/client/RestClient.ts:157
Direct apisauce instance.
Returns
Section titled “Returns”ApisauceInstance
Methods
Section titled “Methods”delete()
Section titled “delete()”delete<
TBody>(url,params?,config?):Promise<RestResponse<TBody>>
Defined in: packages/api-client/src/rest/client/RestClient.ts:189
Issue a DELETE request.
Type Parameters
Section titled “Type Parameters”TBody = unknown
Parameters
Section titled “Parameters”string
params?
Section titled “params?”Record<string, unknown>
config?
Section titled “config?”Returns
Section titled “Returns”Promise<RestResponse<TBody>>
get<
TBody>(url,params?,config?):Promise<RestResponse<TBody>>
Defined in: packages/api-client/src/rest/client/RestClient.ts:162
Issue a GET request. Returns the apisauce response with normalized data.
Type Parameters
Section titled “Type Parameters”TBody = unknown
Parameters
Section titled “Parameters”string
params?
Section titled “params?”Record<string, unknown>
config?
Section titled “config?”Returns
Section titled “Returns”Promise<RestResponse<TBody>>
patch()
Section titled “patch()”patch<
TBody>(url,data?,config?):Promise<RestResponse<TBody>>
Defined in: packages/api-client/src/rest/client/RestClient.ts:198
Issue a PATCH request.
Type Parameters
Section titled “Type Parameters”TBody = unknown
Parameters
Section titled “Parameters”string
unknown
config?
Section titled “config?”Returns
Section titled “Returns”Promise<RestResponse<TBody>>
post()
Section titled “post()”post<
TBody>(url,data?,config?):Promise<RestResponse<TBody>>
Defined in: packages/api-client/src/rest/client/RestClient.ts:171
Issue a POST request.
Type Parameters
Section titled “Type Parameters”TBody = unknown
Parameters
Section titled “Parameters”string
unknown
config?
Section titled “config?”Returns
Section titled “Returns”Promise<RestResponse<TBody>>
put<
TBody>(url,data?,config?):Promise<RestResponse<TBody>>
Defined in: packages/api-client/src/rest/client/RestClient.ts:180
Issue a PUT request.
Type Parameters
Section titled “Type Parameters”TBody = unknown
Parameters
Section titled “Parameters”string
unknown
config?
Section titled “config?”Returns
Section titled “Returns”Promise<RestResponse<TBody>>