Interface SyncTransport

packages/client/src/transport/types/index.ts:18–41

  | 'CLOSED';

export interface SyncTransport {
  isOpen: boolean;
  connectionStatus: ConnectionStatus;
  /**
   * Sends a message to the server. If the message could not be sent, this should return false. If successfully sent, this should return true.
   */
  sendMessage(message: ClientSyncMessage): boolean;
  /**
   * Connect to the server with the given parameters. If this transport is already connected, it should close the existing connection and open a new one.
   */
  connect(params: TransportConnectParams): void;
  /**
   * Closes the connection to the server. If the transport is not connected, this should be a no op.
   */
  close(reason?: CloseReason): void;
  onClose(callback: (ev: any) => void): void;
  /**
   * @deprecated Triplit Client now manages its own connection state, so this is no longer needed.
   */
  onConnectionChange(callback: (state: ConnectionStatus) => void): void;
  onError(callback: (ev: any) => void): void;
  onMessage(callback: (message: any) => void): void;
  onOpen(callback: (ev: any) => void): void;
}

export type TransportConnectParams = {
  server: string;