Interface: ApiResponse

@kortexya/reasoninglayer

---

@kortexya/reasoninglayer / ApiResponse

Interface: ApiResponse<T>

Defined in: src/types/common.ts:14

Generic API response wrapper providing access to response metadata.

Returned by resource client methods when called via .withMetadata().

Example

const result = await client.sorts.withMetadata().getSort(sortId);
console.log(result.data);      // SortDto
console.log(result.status);    // 200
console.log(result.rateLimit); // { limit: 100, remaining: 99, retryAfter: null }

Type Parameters

T

T

Properties

data

data: T

Defined in: src/types/common.ts:16

The parsed response body.

---

headers

headers: Headers

Defined in: src/types/common.ts:20

Raw response headers.

---

rateLimit

rateLimit: RateLimitInfo | null

Defined in: src/types/common.ts:22

Rate limit information parsed from response headers, or null if not present.

---

status

status: number

Defined in: src/types/common.ts:18

HTTP status code.