clean-jsdoc-theme TypeDoc APIv0.0.0

ApiSuccessResponse

interface ApiSuccessResponse<T> { data: T; meta?: ResponseMeta; success: true; }

Source: api.ts:87

API success response wrapper

Type Parameters

  • T — Data type

Example

CODE
type UserResponse = ApiSuccessResponse<User>
// { success: true; data: User; meta?: ResponseMeta }

Properties

data: T

Response data

meta: ResponseMeta

Optional metadata

success: true

Always true for success responses