@osaedasia/oresume
Version:
A user-friendly library for generating complete Single Page Applications (SPAs)
35 lines (34 loc) • 1.09 kB
TypeScript
/**
* Represents the result of an operation with success/failure status and optional data or error message.
* @template T The type of data payload in case of success.
*/
export declare class ResultMessage<T> {
/**
* Literal type identifier for result messages.
*/
readonly type: "result";
/**
* Indicates whether the operation was successful.
*/
readonly success: boolean;
/**
* Optional data payload available on successful operations.
*/
readonly data?: T;
/**
* Optional error message available on failed operations.
*/
readonly error?: string;
/**
* Creates a new result message.
* @param {Object} options The result message configuration.
* @param {boolean} options.success Whether the operation succeeded.
* @param {T} [options.data] Optional data payload for successful operations.
* @param {string} [options.error] Optional error message for failed operations.
*/
constructor(options: {
success: boolean;
data?: T;
error?: string;
});
}