fix: make types compatible with exactOptionalPropertyTypes TypeScri…

…pt config
andipaetzold · Mar 2, 2024 · 76484a2 · 76484a2
1 parent 746b9c4
commit 76484a2
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 18 deletions.
diff --git a/.changeset/soft-lizards-smoke.md b/.changeset/soft-lizards-smoke.md
@@ -0,0 +1,7 @@
+---
+"@andipaetzold/realtime-websocket-client": patch
+"@andipaetzold/realtime-rest-client": patch
+"@andipaetzold/realtime-server": patch
+---
+
+Make types compatible with `exactOptionalPropertyTypes` TypeScript config
diff --git a/packages/realtime-rest-client/src/types.ts b/packages/realtime-rest-client/src/types.ts
@@ -6,7 +6,7 @@ export interface RealtimeRESTClientOptions {
   /**
    * Required for write operations
    */
-  token?: string;
+  token?: string | undefined;
 }
 
 export type Patch = Operation[];
diff --git a/packages/realtime-server/src/types.ts b/packages/realtime-server/src/types.ts
@@ -6,22 +6,26 @@ import type { Auth } from "./auth/index.js";
 
 export interface Options {
   server: HttpServer | HttpsServer | Http2SecureServer;
-  path?: string;
-  initialData?: any;
-  logger?: Logger;
-  auth?: Auth;
-  cors?: {
-    origin: string | string[];
-  };
-  adminUI?: {
-    enabled: boolean;
-    auth:
-      | false
-      | {
-          username: string;
-          password: string;
-        };
-  };
+  path?: string | undefined;
+  initialData?: any | undefined;
+  logger?: Logger | undefined;
+  auth?: Auth | undefined;
+  cors?:
+    | {
+        origin: string | string[];
+      }
+    | undefined;
+  adminUI?:
+    | {
+        enabled: boolean;
+        auth:
+          | false
+          | {
+              username: string;
+              password: string;
+            };
+      }
+    | undefined;
 }
 
 export interface Store {

diff --git a/packages/realtime-websocket-client/src/RealtimeWebSocketClient.ts b/packages/realtime-websocket-client/src/RealtimeWebSocketClient.ts
@@ -20,7 +20,7 @@ interface SubscriptionState<T> {
 
 export interface RealtimeWebSocketClientOptions {
   url: string;
-  onError?: (error: Error) => void;
+  onError?: ((error: Error) => void) | undefined;
 }
 
 export class RealtimeWebSocketClient {