<!DOCTYPE html><html lang="en"><head><meta name="viewport" content="width=device-width,initial-scale=1"><link rel="preload" as="image" href="/favicon.svg"><script async="" src="https://www.googletagmanager.com/gtag/js?id=G-D1MGR8VRWJ"></script><link rel="dns-prefetch" href="https://www.googletagmanager.com/"><link href="https://www.googletagmanager.com/gtag/js?id=G-D1MGR8VRWJ" rel="preload" as="script"><link rel="preload" as="font" href="/fonts/inter.woff2" type="font/woff2" crossorigin="anonymous"><link rel="preload" as="font" href="/fonts/inconsolata.woff2" type="font/woff2" crossorigin="anonymous"><link rel="preload" as="font" href="/fonts/shantell.woff2" type="font/woff2" crossorigin="anonymous"><title>createWsServerSimple | TinyBase</title><meta name="description" content="The createWsServerSimple function creates a WsServerSimple that facilitates synchronization between clients that are using WsSynchronizer instances."><meta property="og:type" content="website"><meta property="og:title" content="createWsServerSimple | TinyBase"><meta property="og:description" content="The createWsServerSimple function creates a WsServerSimple that facilitates synchronization between clients that are using WsSynchronizer instances."><meta property="og:url" content="https://tinybase.org/api/synchronizer-ws-server-simple/functions/creation/createwsserversimple/"><meta property="og:image" content="https://tinybase.org/favicon_pad.png"><meta name="twitter:card" content="summary"><meta name="twitter:title" content="createWsServerSimple | TinyBase"><meta name="twitter:description" content="The createWsServerSimple function creates a WsServerSimple that facilitates synchronization between clients that are using WsSynchronizer instances."><meta name="twitter:site" content="@tinybasejs"><meta name="twitter:image" content="https://tinybase.org/favicon_pad.png"><link rel="icon" type="image/svg+xml" href="/favicon.svg"><link rel="canonical" href="https://tinybase.org/api/synchronizer-ws-server-simple/functions/creation/createwsserversimple/"><link rel="stylesheet" href="/css/index.css"><script src="/js/app.js"></script></head><body><header><a href="/"><img src="/favicon.svg" alt="TinyBase logo"><span>TinyBase</span></a><nav><ul><li><a href="/guides/">Guides</a></li><li><a href="/demos/">Demos</a></li><li><a href="/api/">API</a></li><li><a href="https://github.com/tinyplex/tinybase">GitHub</a></li></ul></nav><span id="dark"></span></header><main><nav><ul><li id="root" class="parent open"><span></span><a href="/">TinyBase</a><ul><li id="G" class="parent"><span></span><a href="/guides/">Guides</a></li><li id="D2" class="parent"><span></span><a href="/demos/">Demos</a></li><li id="api" class="parent open"><span></span><a href="/api/">API</a><ul><li id="e" class="parent"><span></span><a href="/api/the-essentials/">The Essentials</a></li><li id="s" class="parent"><span></span><a href="/api/store/"><code>store</code></a></li><li id="m" class="parent"><span></span><a href="/api/mergeable-store/"><code>mergeable-store</code></a></li><li id="m3" class="parent"><span></span><a href="/api/metrics/"><code>metrics</code></a></li><li id="i" class="parent"><span></span><a href="/api/indexes/"><code>indexes</code></a></li><li id="r" class="parent"><span></span><a href="/api/relationships/"><code>relationships</code></a></li><li id="q" class="parent"><span></span><a href="/api/queries/"><code>queries</code></a></li><li id="c" class="parent"><span></span><a href="/api/checkpoints/"><code>checkpoints</code></a></li><li id="c3" class="parent"><span></span><a href="/api/common/"><code>common</code></a></li><li id="p" class="parent"><span></span><a href="/api/persisters/"><code>persisters</code></a></li><li id="p2" class="parent"><span></span><a href="/api/persister-automerge/"><code>persister-automerge</code></a></li><li id="p3" class="parent"><span></span><a href="/api/persister-browser/"><code>persister-browser</code></a></li><li id="p4" class="parent"><span></span><a href="/api/persister-cr-sqlite-wasm/"><code>persister-cr-sqlite-wasm</code></a></li><li id="p5" class="parent"><span></span><a href="/api/persister-durable-object-sql-storage/"><code>persister-durable-object-sql-storage</code></a></li><li id="p6" class="parent"><span></span><a href="/api/persister-durable-object-storage/"><code>persister-durable-object-storage</code></a></li><li id="p7" class="parent"><span></span><a href="/api/persister-electric-sql/"><code>persister-electric-sql</code></a></li><li id="p8" class="parent"><span></span><a href="/api/persister-expo-sqlite/"><code>persister-expo-sqlite</code></a></li><li id="p9" class="parent"><span></span><a href="/api/persister-file/"><code>persister-file</code></a></li><li id="p10" class="parent"><span></span><a href="/api/persister-indexed-db/"><code>persister-indexed-db</code></a></li><li id="p11" class="parent"><span></span><a href="/api/persister-libsql/"><code>persister-libsql</code></a></li><li id="p12" class="parent"><span></span><a href="/api/persister-partykit-client/"><code>persister-partykit-client</code></a></li><li id="p13" class="parent"><span></span><a href="/api/persister-partykit-server/"><code>persister-partykit-server</code></a></li><li id="p14" class="parent"><span></span><a href="/api/persister-pglite/"><code>persister-pglite</code></a></li><li id="p15" class="parent"><span></span><a href="/api/persister-postgres/"><code>persister-postgres</code></a></li><li id="p16" class="parent"><span></span><a href="/api/persister-powersync/"><code>persister-powersync</code></a></li><li id="p17" class="parent"><span></span><a href="/api/persister-react-native-mmkv/"><code>persister-react-native-mmkv</code></a></li><li id="p18" class="parent"><span></span><a href="/api/persister-react-native-sqlite/"><code>persister-react-native-sqlite</code></a></li><li id="p19" class="parent"><span></span><a href="/api/persister-remote/"><code>persister-remote</code></a></li><li id="p20" class="parent"><span></span><a href="/api/persister-sqlite-bun/"><code>persister-sqlite-bun</code></a></li><li id="p21" class="parent"><span></span><a href="/api/persister-sqlite-wasm/"><code>persister-sqlite-wasm</code></a></li><li id="p22" class="parent"><span></span><a href="/api/persister-sqlite3/"><code>persister-sqlite3</code></a></li><li id="p23" class="parent"><span></span><a href="/api/persister-yjs/"><code>persister-yjs</code></a></li><li id="s50" class="parent"><span></span><a href="/api/synchronizers/"><code>synchronizers</code></a></li><li id="s53" class="parent"><span></span><a href="/api/synchronizer-broadcast-channel/"><code>synchronizer-broadcast-channel</code></a></li><li id="s56" class="parent"><span></span><a href="/api/synchronizer-local/"><code>synchronizer-local</code></a></li><li id="s59" class="parent"><span></span><a href="/api/synchronizer-ws-client/"><code>synchronizer-ws-client</code></a></li><li id="s62" class="parent"><span></span><a href="/api/synchronizer-ws-server/"><code>synchronizer-ws-server</code></a></li><li id="s63" class="parent"><span></span><a href="/api/synchronizer-ws-server-durable-object/"><code>synchronizer-ws-server-durable-object</code></a></li><li id="s64" class="parent open"><span></span><a href="/api/synchronizer-ws-server-simple/"><code>synchronizer-ws-server-simple</code></a><ul><li id="s64/I50" class="parent"><span></span><a href="/api/synchronizer-ws-server-simple/interfaces/">Interfaces</a></li><li id="s64/F38" class="parent open"><span></span><a href="/api/synchronizer-ws-server-simple/functions/">Functions</a><ul><li id="cWSS" class="current"><span></span><a href="/api/synchronizer-ws-server-simple/functions/creation/createwsserversimple/"><code>createWsServerSimple</code></a></li></ul></li></ul></li><li id="u" class="parent"><span></span><a href="/api/ui-react/"><code>ui-react</code></a></li><li id="u2" class="parent"><span></span><a href="/api/ui-react-dom/"><code>ui-react-dom</code></a></li><li id="u3" class="parent"><span></span><a href="/api/ui-react-inspector/"><code>ui-react-inspector</code></a></li></ul></li></ul></li></ul></nav><article><nav><ul><li><a href="/">TinyBase</a></li><li><a href="/api/">API</a></li><li><a href="/api/synchronizer-ws-server-simple/"><code>synchronizer-ws-server-simple</code></a></li><li><a href="/api/synchronizer-ws-server-simple/functions/">Functions</a></li><li><a href="/api/synchronizer-ws-server-simple/functions/creation/createwsserversimple/"><code>createWsServerSimple</code></a></li></ul></nav><section class="s1" id="/api/synchronizer-ws-server-simple/functions/creation/createwsserversimple/" data-id="cWSS"><h1><code>createWsServerSimple</code></h1><p>The <code>createWsServerSimple</code> function creates a <a href="/api/synchronizer-ws-server-simple/interfaces/server/wsserversimple/"><code>WsServerSimple</code></a> that facilitates synchronization between clients that are using <a href="/api/synchronizer-ws-client/interfaces/synchronizer/wssynchronizer/"><code>WsSynchronizer</code></a> instances.</p><pre><code><span class="function"><a href="/api/synchronizer-ws-server-simple/functions/creation/createwsserversimple/">createWsServerSimple</a></span><span class="punctuation">(</span>webSocketServer<span class="operator">:</span> WebSocketServer<span class="punctuation">)</span><span class="operator">:</span> <span class="type"><a href="/api/synchronizer-ws-server-simple/interfaces/server/wsserversimple/">WsServerSimple</a></span></code></pre><div class="table"><table><tr><th></th><th>Type</th><th>Description</th></tr><tr><th><code>webSocketServer</code></th><td><code>WebSocketServer</code></td><td><p>A WebSocketServer object from your server environment.</p></td></tr><tr><th class="right">returns</th><td><code><span class="type"><a href="/api/synchronizer-ws-server-simple/interfaces/server/wsserversimple/">WsServerSimple</a></span></code></td><td><p></p><p>A reference to the new <a href="/api/synchronizer-ws-server-simple/interfaces/server/wsserversimple/"><code>WsServerSimple</code></a> object.</p><p></p></td></tr></table></div><p>This should be run in a server environment, and you must pass in a configured WebSocketServer object in order to create it.</p><p>The core functionality is equivalent to the <a href="/api/synchronizer-ws-server/interfaces/server/wsserver/"><code>WsServer</code></a> interface, but without the complications of listeners, persistence, or statistics. This makes it more suitable to be used as a reference implementation for other server environments.</p><section class="s2"><h2>Example</h2><p>This example creates a <a href="/api/synchronizer-ws-server-simple/interfaces/server/wsserversimple/"><code>WsServerSimple</code></a> that synchronizes two clients on a shared path.</p><pre><code><span class="keyword">import</span> <span class="punctuation">{</span>createMergeableStore<span class="punctuation">}</span> <span class="keyword">from</span> <span class="string">'tinybase'</span><span class="punctuation">;</span>
0 commit comments