TLRemoteSyncError

Extends Error.

Specialized error class for synchronization-related failures in tldraw collaboration.

This error is thrown when the sync client encounters fatal errors that prevent successful synchronization with the server. It captures both the error message and the specific reason code that triggered the failure.

Common scenarios include schema version mismatches, authentication failures, network connectivity issues, and server-side validation errors.

class TLRemoteSyncError extends Error {}

Example

import {
  TLRemoteSyncError,
  TLSyncErrorCloseEventReason,
} from '@tldraw/sync-core'

// Handle sync errors in your application
syncClient.onSyncError((error) => {
  if (error instanceof TLRemoteSyncError) {
    switch (error.reason) {
      case TLSyncErrorCloseEventReason.NOT_AUTHENTICATED:
        // Redirect user to login
        break
      case TLSyncErrorCloseEventReason.CLIENT_TOO_OLD:
        // Show update required message
        break
      default:
        console.error('Sync error:', error.message)
    }
  }
})

// Server-side: throwing a sync error
if (!hasPermission(userId, roomId)) {
  throw new TLRemoteSyncError(TLSyncErrorCloseEventReason.FORBIDDEN)
}

Creates a new TLRemoteSyncError with the specified reason.

reason - The specific reason code or custom string describing why the sync failed. When using predefined reasons from TLSyncErrorCloseEventReason, the client can handle specific error types appropriately. Custom strings allow for application-specific error details.

Parameters

string | TLSyncErrorCloseEventReason

Properties

name: string

readonly reason: string | TLSyncErrorCloseEventReason