/**
* An object representing a successful operation with a result of type `T`.
*/
export type Success<T> = {
success: true;
data: T;
};
/**
* An object representing an operation that failed for the reason given in `message`.
*/
export type Error = {
success: false;
message: string;
};
/**
* An object representing a successful or failed operation of type `T`.
*/
export type Result<T> = Success<T> | Error;
/**
* Returns a `Success<T>` object.
* @param data The value for the `data` property of the result.
* @returns A `Success<T>` object.
*/
export declare function success<T>(data: T): Success<T>;
/**
* Returns an `Error` object.
* @param message The value for the `message` property of the result.
* @returns An `Error` object.
*/
export declare function error(message: string): Error;
/**
* Obtains the value associated with a successful `Result<T>` or throws an exception if
* the result is an error.
* @param result The `Result<T>` from which to obtain the `data` property.
* @returns The value of the `data` property.
*/
export declare function getData<T>(result: Result<T>): T;
It would be useful to get access to data typed as unknown even if result.success === false. This would enable you to use the data and create your own repair pipeline.
It would be useful to get access to
data
typed asunknown
even ifresult.success === false
. This would enable you to use the data and create your own repair pipeline.