createClient

Creates a Socket.IO-backed URQL client with custom exchanges.

Signature

function createClient(options: ClientOptions): {
  client: UrqlClient
  manager: SocketManager
  invalidate: (target: string | DocumentNode | Array) => void
}

Options

Option	Type	Default	Description
path	string	'/ws/'	Socket.IO server path
transports	string[]	['websocket']	Allowed transports
graphqlNamespace	string	'graphql'	Socket.IO namespace to connect to
onConnect	() => object	—	Return auth data for the connection

Return Values

Property	Type	Description
client	UrqlClient	Configured URQL client with Suspense enabled
manager	SocketManager	The underlying Socket.IO manager
invalidate	Function	Manually invalidate cached operation results

invalidate

// Single query by operation name
invalidate('Users')

// Single query by document node
invalidate(UsersDocument)

// Multiple queries
invalidate(['Users', ProjectsDocument])

waitForResult

Exported from @requence/socketql/client, this utility returns a promise that resolves when specific query results arrive:

import { waitForResult } from '@requence/socketql/client'

await waitForResult('Users')
await waitForResult(['Users', 'Projects'])