Interface BaseResponse

Base envelope for every API response (success or failure).

interface BaseResponse {
    code?: ApiErrorCode;
    error?: string;
    success: boolean;
}

Index

Properties

code? error? success

Properties

`Optional`code

code?: ApiErrorCode

Machine-readable error code on migrated APIs.

`Optional`error

error?: string

Error message when success is false.

success

success: boolean