feat(client): allow unsubscribing the "once" call

TimoBechtel · Jul 13, 2023 · 0fca516 · 0fca516
1 parent 3babdd6
commit 0fca516
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/apps/docs/docs/guide/client.md b/apps/docs/docs/guide/client.md
@@ -81,7 +81,7 @@ const unsubscribe = db.get('friends/status').on((data, meta) => {
 
 ## once
 
-`once: (callback: (data: any, meta: Meta) => void) => void`
+`once: (callback: (data: any, meta: Meta) => void) => Unsubscriber`
 
 Same as `on`, but only receives data once.
 It will automatically unsubscribe from server after receiving data.

diff --git a/packages/client/src/lib/client.ts b/packages/client/src/lib/client.ts
@@ -76,7 +76,7 @@ export type ChainReference<Schema extends SchemaDefinition = any> = {
 	) => ChainReference<Schema>;
 	delete: () => void;
 	on: (callback: (data: Schema | null, meta?: Meta) => void) => Unsubscriber;
-	once: (callback: (data: Schema | null, meta?: Meta) => void) => void;
+	once: (callback: (data: Schema | null, meta?: Meta) => void) => Unsubscriber;
 };
 
 export type ClientHooks = {
@@ -373,7 +373,7 @@ export function SocketDBClient<Schema extends RootSchemaDefinition = any>({
 				});
 			},
 			once(callback) {
-				subscriptions.update.subscribe(
+				return subscriptions.update.subscribe(
 					normalizedPath,
 					function listener(data) {
 						// maybe should use subscribe {once: true} ?