Class ApiRestClient<TEntity>

constructor

• new ApiRestClient<TEntity = any>(
      config: RestClientConfigParams,
  ): ApiRestClient<TEntity>

• Type Parameters

  • TEntity = any

  Parameters

  • config: RestClientConfigParams

  Returns ApiRestClient<TEntity>

httpClient

path

requestInterceptor

responseInterceptor

count

• count(params?: { [key: string]: any }): Promise<ApiResponse<number>>

• Parameters

  • Optionalparams: { [key: string]: any }

  Returns Promise<ApiResponse<number>>

create

• create<TCreateParams>(
      entity: TEntity | TCreateParams,
      params?: { [key: string]: any },
  ): Promise<ApiResponse<TEntity>>

• Type Parameters

  • TCreateParams

  Parameters

  • entity: TEntity | TCreateParams
  • Optionalparams: { [key: string]: any }

  Returns Promise<ApiResponse<TEntity>>

delete

• delete(
      id: string | number,
      params?: { [key: string]: any },
  ): Promise<ApiResponse<TEntity>>

• Parameters

  • id: string | number
  • Optionalparams: { [key: string]: any }

  Returns Promise<ApiResponse<TEntity>>

ejectInterceptors

• ejectInterceptors(): void

• Returns void

get

• get(params?: { [key: string]: any }): Promise<ApiResponse<TEntity>>

• Parameters

  • Optionalparams: { [key: string]: any }

  Returns Promise<ApiResponse<TEntity>>

getById

• getById(
      id: string | number,
      params?: { [key: string]: any },
  ): Promise<ApiResponse<TEntity>>

• Parameters

  • id: string | number
  • Optionalparams: { [key: string]: any }

  Returns Promise<ApiResponse<TEntity>>

request

• request(method: RequestMethod, data?: unknown): Promise<ApiResponse<TEntity>>

• Parameters

  • method: RequestMethod
  • Optionaldata: unknown

  Returns Promise<ApiResponse<TEntity>>

unauthorizedResponseHandler

• unauthorizedResponseHandler(): void

• Returns void

update

• update<TUpdateParams>(
      id: string | number,
      entity: TEntity | TUpdateParams,
      params?: { [key: string]: any },
      patch?: boolean,
  ): Promise<ApiResponse<TEntity>>

• Type Parameters

  • TUpdateParams

  Parameters

  • id: string | number
  • entity: TEntity | TUpdateParams
  • Optionalparams: { [key: string]: any }
  • Optionalpatch: boolean

  Returns Promise<ApiResponse<TEntity>>

StaticcreateInstance

• createInstance<TEnity = any>(
      config: RestClientConfigParams,
  ): ApiRestClient<TEnity>

• Type Parameters

  • TEnity = any

  Parameters

  • config: RestClientConfigParams

  Returns ApiRestClient<TEnity>

StatictoApiReponse

• toApiReponse(apiResponse: any): ApiResponse<any>

• Parameters

  • apiResponse: any

  Returns ApiResponse<any>