feat!: rename onRemoteError to onFunctionError, onLocalError to onGeneralError

This is a breaking change to a new feature that releases half an hour ago, the names were confusing, and this changes improves it. Supposely this shouldn't break anyone.

Author: antfu

src/index.ts

@@ -61,23 +61,23 @@ export interface EventOptions<Remote> {
   /**
    * Custom error handler
    *
-   * @deprecated use `onRemoteError` and `onLocalError` instead
+   * @deprecated use `onFunctionError` and `onGeneralError` instead
    */
   onError?: (error: Error, functionName: string, args: any[]) => boolean | void
 
   /**
-   * Custom error handler for errors occurred in remote functions
+   * Custom error handler for errors occurred in local functions being called
    *
    * @returns `true` to prevent the error from being thrown
    */
-  onRemoteError?: (error: Error, functionName: string, args: any[]) => boolean | void
+  onFunctionError?: (error: Error, functionName: string, args: any[]) => boolean | void
 
   /**
-   * Custom error handler for errors occurred in local functions or during serialization
+   * Custom error handler for errors occurred during serialization or messsaging
    *
    * @returns `true` to prevent the error from being thrown
    */
-  onLocalError?: (error: Error, functionName?: string, args?: any[]) => boolean | void
+  onGeneralError?: (error: Error, functionName?: string, args?: any[]) => boolean | void
 
   /**
    * Custom error handler for timeouts
@@ -282,7 +282,7 @@ export function createBirpc<RemoteFunctions = Record<string, never>, LocalFuncti
       msg = deserialize(data) as RPCMessage
     }
     catch (e) {
-      if (options.onLocalError?.(e as Error) !== true)
+      if (options.onGeneralError?.(e as Error) !== true)
         throw e
       return
     }
@@ -310,8 +310,8 @@ export function createBirpc<RemoteFunctions = Record<string, never>, LocalFuncti
         // Error handling
         if (error && options.onError)
           options.onError(error, method, args)
-        if (error && options.onRemoteError) {
-          if (options.onRemoteError(error, method, args) === true)
+        if (error && options.onFunctionError) {
+          if (options.onFunctionError(error, method, args) === true)
             return
         }
 
@@ -323,7 +323,7 @@ export function createBirpc<RemoteFunctions = Record<string, never>, LocalFuncti
           }
           catch (e) {
             error = e
-            if (options.onLocalError?.(e as Error, method, args) !== true)
+            if (options.onGeneralError?.(e as Error, method, args) !== true)
               throw e
           }
         }
@@ -332,7 +332,7 @@ export function createBirpc<RemoteFunctions = Record<string, never>, LocalFuncti
           post(serialize(<Response>{ t: TYPE_RESPONSE, i: msg.i, e: error }), ...extra)
         }
         catch (e) {
-          if (options.onLocalError?.(e as Error, method, args) !== true)
+          if (options.onGeneralError?.(e as Error, method, args) !== true)
             throw e
         }
       }

test/error.test.ts

@@ -7,7 +7,7 @@ import * as Bob from './bob'
 type BobFunctions = typeof Bob
 type AliceFunctions = typeof Alice
 
-it('on remote error', async () => {
+it('on function error', async () => {
   const channel = new MessageChannel()
 
   let error: any
@@ -17,7 +17,7 @@ it('on remote error', async () => {
     {
       post: data => channel.port1.postMessage(data),
       on: fn => channel.port1.on('message', fn),
-      onRemoteError(err, method, args) {
+      onFunctionError(err, method, args) {
         error = { err, method, args }
       },
     },
@@ -66,7 +66,7 @@ it('on serialize error', async () => {
       },
       post: data => channel.port1.postMessage(data),
       on: fn => channel.port1.on('message', fn),
-      onLocalError(err, method, args) {
+      onGeneralError(err, method, args) {
         error = { err, method, args }
         return true
       },
@@ -112,7 +112,7 @@ it('on parse error', async () => {
       },
       post: data => channel.port1.postMessage(data),
       on: fn => channel.port1.on('message', fn),
-      onLocalError(err, method, args) {
+      onGeneralError(err, method, args) {
         error = { err, method, args }
         return true
       },