Interface Result<T>

A request result wrapper object.

interface Result<T> {
    code?: string;
    data?: T;
    errors?: ErrorDetail[];
    message?: string;
    meta?: DatumStreamMetadataInfo[];
    success: boolean;
}

Type Parameters

T
the result data type

Index

Properties

code? data? errors? message? meta? success

Properties

`Optional`code

code?: string

A code, such as an error condition identifier.

`Optional`data

data?: T

Result data.

`Optional`errors

errors?: ErrorDetail[]

Error details, such as input validation failures.

`Optional`message

message?: string

A message, such as an error message.

`Optional`meta

meta?: DatumStreamMetadataInfo[]

Optional datum stream metadata.

success

success: boolean

Flag indicating if the request was successfully processed.