Error codes

Every failure has a stable Error code in code. You'll find it on errors that are thrown, on errors a Promise rejects with, and on the error in events such as onFileTransferFinished and onFileReceiveFailed.

The same failure has the same code whichever function reports it. For example, sendMessage and sendMessageWithoutReply both use ERR_WATCH_NOT_REACHABLE.

WatchConnectErrorCodeCopy Anchor Link

import { type WatchConnectErrorCode } from "rn-watch-connect";

The TypeScript union of every code on this page. Use it to type the codes you check, so a misspelled code fails to compile.

Example

import RnWatchConnect, { type WatchConnectErrorCode } from "rn-watch-connect";

function errorCode(error: unknown): WatchConnectErrorCode | undefined {
  return (error as { code?: WatchConnectErrorCode } | null)?.code;
}

try {
  await RnWatchConnect.sendMessageWithoutReply({ ping: 1 });
} catch (error) {
  switch (errorCode(error)) {
    case "ERR_WATCH_NOT_REACHABLE":
      // Try again later, or use transferUserInfo, which doesn't need the Watch to be reachable.
      break;
    case "ERR_UNSUPPORTED_PLATFORM":
      // Not on iOS: hide your Watch features.
      break;
    default:
      throw error;
  }
}

The library's own codesCopy Anchor Link

WatchConnectivity's codesCopy Anchor Link

WatchConnectivity's own errors, for example when sending, when updating the Application Context, or in finish events, use ERR_ plus the name of Apple's WCError.Code. Its notReachable uses the library's ERR_WATCH_NOT_REACHABLE, so one failure has one code.