clean-jsdoc-theme TypeDoc APIv0.0.0

ApiResponse

ApiResponse<T> = ApiSuccessResponse<T> | ApiErrorResponse

Source: api.ts:140

Combined API response type

Type Parameters

  • T — Success data type

Example

CODE
async function fetchUser(id: string): Promise<ApiResponse<User>> {
  const response = await api.get(`/users/${id}`)
  if (response.success) {
    console.log(response.data.name)
  } else {
    console.error(response.error.message)
  }
  return response
}