Primitive Docs

Appearance

js-bao-wss-client

js-bao-wss-client / JsBaoClientOptions

Interface: JsBaoClientOptions ​

Properties ​

analyticsAutoEvents? ​

optional analyticsAutoEvents: AnalyticsAutoEventsOptions

apiUrl ​

apiUrl: string

appId ​

appId: string

auth? ​

optional auth: object

persistJwtInStorage? ​

optional persistJwtInStorage: boolean

refreshProxy? ​

optional refreshProxy: object

refreshProxy.baseUrl ​

baseUrl: string

refreshProxy.cookieMaxAgeSeconds? ​

optional cookieMaxAgeSeconds: number

refreshProxy.enabled? ​

optional enabled: boolean

storageKeyPrefix? ​

optional storageKeyPrefix: string

autoNetwork? ​

optional autoNetwork: boolean

autoOAuth? ​

optional autoOAuth: boolean

autoUnlockOfflineOnInit? ​

optional autoUnlockOfflineOnInit: boolean

blobUploadConcurrency? ​

optional blobUploadConcurrency: number

commitRetryBackoff? ​

optional commitRetryBackoff: object

baseMs? ​

optional baseMs: number

factor? ​

optional factor: number

jitter? ​

optional jitter: boolean

maxMs? ​

optional maxMs: number

connectivityProbeTimeoutMs? ​

optional connectivityProbeTimeoutMs: number

databaseConfig? ​

optional databaseConfig: DatabaseConfig

globalAdminAppId? ​

optional globalAdminAppId: string

logLevel? ​

optional logLevel: LogLevel

maxReconnectDelay? ​

optional maxReconnectDelay: number

models ​

models: TypedModelConstructor<any>[]

oauthRedirectUri? ​

optional oauthRedirectUri: string

offline? ​

optional offline: boolean

onConnectivityCheck()? ​

optional onConnectivityCheck: () => Promise<boolean>

Returns ​

Promise<boolean>

serviceWorkerBridge? ​

optional serviceWorkerBridge: object

enabled? ​

optional enabled: boolean

storageConfig? ​

optional storageConfig: StorageConfig

suppressAutoLoginMs? ​

optional suppressAutoLoginMs: number

sync? ​

optional sync: object

handshakeTimeoutMs? ​

optional handshakeTimeoutMs: number

outboundDebounceMs? ​

optional outboundDebounceMs: number

token? ​

optional token: string

wsHeaders? ​

optional wsHeaders: Record<string, string>

wsUrl ​

wsUrl: string

yjsPersistence? ​

optional yjsPersistence: YjsPersistenceFactory

Custom Yjs persistence factory for document storage.

If not provided:

  • Browser: uses y-indexeddb (built-in)
  • Node.js: no Yjs persistence (documents only synced via server)

For Node.js persistence, use y-sqlite3:

Example ​

typescript
import { SqlitePersistence } from 'y-sqlite3';

const client = new JsBaoClient({
  // ...
  yjsPersistence: (docId, ydoc, { appId, userId }) => {
    return new SqlitePersistence(docId, ydoc, {
      dbPath: `~/.my-app/${appId}/${userId}/yjs.sqlite`
    });
  }
});