feat: allow custom errors in $close (#23)

sheremet-va · web-flow · commit c5ab90ef5853 · 2025-03-25T08:27:17.000+08:00
diff --git a/src/index.ts b/src/index.ts
@@ -109,7 +109,7 @@ export interface BirpcGroupFn<T> {
 
 export type BirpcReturn<RemoteFunctions, LocalFunctions = Record<string, never>> = {
   [K in keyof RemoteFunctions]: BirpcFn<RemoteFunctions[K]>
-} & { $functions: LocalFunctions, $close: () => void }
+} & { $functions: LocalFunctions, $close: (error?: Error) => void }
 
 export type BirpcGroupReturn<RemoteFunctions> = {
   [K in keyof RemoteFunctions]: BirpcGroupFn<RemoteFunctions[K]>
@@ -266,10 +266,10 @@ export function createBirpc<RemoteFunctions = Record<string, never>, LocalFuncti
     },
   }) as BirpcReturn<RemoteFunctions, LocalFunctions>
 
-  function close() {
+  function close(error?: Error) {
     closed = true
     rpcPromiseMap.forEach(({ reject, method }) => {
-      reject(new Error(`[birpc] rpc is closed, cannot call "${method}"`))
+      reject(error || new Error(`[birpc] rpc is closed, cannot call "${method}"`))
     })
     rpcPromiseMap.clear()
     off(onMessage)
diff --git a/test/close.test.ts b/test/close.test.ts
@@ -23,3 +23,24 @@ it('stops the rpc promises', async () => {
   await promise
   await expect(() => rpc.hello()).rejects.toThrow('[birpc] rpc is closed, cannot call "hello"')
 })
+
+it('stops the rpc promises with a custom message', async () => {
+  expect.assertions(1)
+  const rpc = createBirpc<{ hello: () => string }>({}, {
+    on() {},
+    post() {},
+  })
+  const promise = rpc.hello().then(
+    () => {
+      throw new Error('Promise should not resolve')
+    },
+    (err) => {
+      // Promise should reject
+      expect(err.message).toBe('Custom error')
+    },
+  )
+  nextTick(() => {
+    rpc.$close(new Error('Custom error'))
+  })
+  await promise
+})
