doc: export return type for syncShapeToTable (#452)

* doc: export return type for syncShapeToTable * feat: expose stream object as of for useShape hook * Changeset --------- Co-authored-by: Sam Willis <[email protected]>
electric-sql · Dec 8, 2024 · c3d98d5 · c3d98d5
1 parent bfddaaa
commit c3d98d5
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/.changeset/poor-cheetahs-beg.md b/.changeset/poor-cheetahs-beg.md
@@ -0,0 +1,5 @@
+---
+'@electric-sql/pglite-sync': patch
+---
+
+Export return type of `syncShapeToTable`
diff --git a/packages/pglite-sync/src/index.ts b/packages/pglite-sync/src/index.ts
@@ -4,6 +4,7 @@ import {
   ShapeStream,
   isChangeMessage,
   isControlMessage,
+  ShapeStreamInterface,
 } from '@electric-sql/client'
 import type {
   Extension,
@@ -30,6 +31,14 @@ export interface SyncShapeToTableOptions {
   useCopy?: boolean
 }
 
+export interface SyncShapeToTableResult {
+  unsubscribe: () => void
+  readonly isUpToDate: boolean
+  readonly shapeId: string
+  subscribe: (cb: () => void, error: (err: Error) => void) => () => void
+  stream: ShapeStreamInterface
+}
+
 export interface ElectricSyncOptions {
   debug?: boolean
   metadataSchema?: string
@@ -52,7 +61,9 @@ async function createPlugin(
   const shapePerTableLock = new Map<string, void>()
 
   const namespaceObj = {
-    syncShapeToTable: async (options: SyncShapeToTableOptions) => {
+    syncShapeToTable: async (
+      options: SyncShapeToTableOptions,
+    ): Promise<SyncShapeToTableResult> => {
       if (shapePerTableLock.has(options.table)) {
         throw new Error('Already syncing shape for table ' + options.table)
       }
@@ -240,6 +251,7 @@ async function createPlugin(
         get shapeId() {
           return stream.shapeHandle
         },
+        stream,
         subscribe: (cb: () => void, error: (err: Error) => void) => {
           return stream.subscribe(() => {
             if (stream.isUpToDate) {