Client

Installation

npm i @rouage/client

This is an ESM-only package. Type definitions are included.

Configuration

import { SyncEngine } from '@rouage/client'

const syncEngine = new SyncEngine({
  roomId: 'account123',
})

Data Fetching

async function fetchPosts() {
  const response = await fetch('https://jsonplaceholder.org/posts')
  return response.json() as unknown as Post[]
}

const syncQuery = syncEngine.createQuery({
  queryKey: ['posts'],
  queryCall: fetchPosts,
})

Subscription

syncQuery.subscribe(posts => console.log(posts))

syncQuery.unsubscribe()

Invalidation

syncEngine.invalidate({ queryKey: ['posts'] })