Skip to content

SuccessResponse<T>

@blobs/sdk v0.1.0


@blobs/sdk / utils/types / SuccessResponse

SuccessResponse<T> = object

Defined in: utils/types.ts:71

Successful API response envelope.

Type Parameters

T

T

The data payload type.

Properties

success

success: true

Defined in: utils/types.ts:73

Discriminator; always true for success.


data

data: T

Defined in: utils/types.ts:75

Response payload.


meta?

optional meta?: object

Defined in: utils/types.ts:77

Optional pagination/total metadata.

total?

optional total?: number

Total number of records (pre-pagination).

page?

optional page?: number

Current page (1-indexed) when paginated.

limit?

optional limit?: number

Page size when paginated.