@kontent-ai/sync-sdk
Version:
Sync API v2 for Kontent.ai
28 lines (27 loc) • 767 B
TypeScript
import type { SyncSdkError } from "./core.models.js";
/**
* A nomadic result type that represents a success or failure of an operation.
*
* Ensures that consumers of this library handle both success and failure cases.
*/
export type QueryResult<TResponse> = (Success & {
readonly response: TResponse;
}) | (Failure & {
readonly response?: never;
});
export type PagingQueryResult<TResponse> = (Success & {
readonly responses: TResponse[];
readonly lastContinuationToken: string;
}) | (Failure & {
readonly responses?: never;
readonly lastContinuationToken?: never;
});
type Success = {
readonly success: true;
readonly error?: never;
};
type Failure = {
readonly success: false;
readonly error: SyncSdkError;
};
export {};