feat(type): service-response

Alwatr · Dec 30, 2022 · 18f8be3 · 18f8be3
1 parent d4b3a95
commit 18f8be3
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/core/type/src/service-response.ts b/core/type/src/service-response.ts
@@ -0,0 +1,28 @@
+export type AlwatrServiceResponseFailed = {
+  ok: false;
+  statusCode: number;
+  errorCode: string;
+  meta?: Record<string, unknown>;
+  data?: never;
+};
+
+export type AlwatrServiceResponseSuccess<TData = Record<string, unknown>> = {
+  ok: true;
+  statusCode?: number;
+  errorCode?: never;
+  meta?: never;
+  data: TData;
+};
+
+export type AlwatrServiceResponseSuccessWithMeta<TData = Record<string, unknown>, TMeta = Record<string, unknown>> = {
+  ok: true;
+  statusCode?: number;
+  errorCode?: never;
+  meta: TMeta;
+  data: TData;
+};
+
+export type AlwatrServiceResponse<TData = Record<string, unknown>, TMeta = Record<string, unknown>> =
+  | AlwatrServiceResponseSuccess<TData>
+  | AlwatrServiceResponseSuccessWithMeta<TData, TMeta>
+  | AlwatrServiceResponseFailed;