clean-jsdoc-theme TypeDoc APIv0.0.0

isSuccessResponse

isSuccessResponse< T, >( response: ApiResponse<T>, ): response is ApiSuccessResponse<T>

Source: api.ts:517

Type guard for success responses

Type Parameters

  • T — Data type

Parameters

Returns

Example

CODE
const response = await api.getUser('123')
if (isSuccessResponse(response)) {
  console.log(response.data.name) // TypeScript knows data exists
}