APIResponse

@codebolt/codeboltjs

---

Interface: APIResponse<T>

Defined in: packages/codeboltjs/src/types/libFunctionTypes.ts:1716

Standard API response wrapper

Type Parameters

Type Parameter	Default type
T	unknown

Properties

Property	Type	Description	Defined in
code?	string	Error code if unsuccessful	packages/codeboltjs/src/types/libFunctionTypes.ts:1724
data?	T	Response data	packages/codeboltjs/src/types/libFunctionTypes.ts:1720
error?	string	Error message if unsuccessful	packages/codeboltjs/src/types/libFunctionTypes.ts:1722
metadata?	Record<string, unknown>	Additional metadata	packages/codeboltjs/src/types/libFunctionTypes.ts:1726
success	boolean	Whether the operation was successful	packages/codeboltjs/src/types/libFunctionTypes.ts:1718