Server

The server module creates a Socket.IO server with a full GraphQL execution pipeline, including live query support and schema transformation.

createServer

import { createServer } from '@requence/socketql/server'

const { server, namespace, liveQueryStore, attach, addSchema } = createServer({
  path: '/ws/',
  transports: ['websocket'],
  redisUrl: 'redis://localhost:6379',
})

Adding Schemas

Use addSchema to register GraphQL type definitions and resolvers:

addSchema({
  typeDefs: /* GraphQL */ `
    type Query {
      hello: String! @live
    }
  `,
  resolvers: {
    Query: {
      hello: () => 'world',
    },
  },
})

Attaching to a Server

Node.js

import { createServer as createHTTPServer } from 'node:http'

const httpServer = createHTTPServer()
attach(httpServer)
httpServer.listen(4000)

Bun

Import from @requence/socketql/server/bun instead — it replaces attach with a handler() method:

import { createServer } from '@requence/socketql/server/bun'

const { addSchema, handler } = createServer({ path: '/ws/' })

addSchema({ typeDefs, resolvers })

export default { port: 4000, ...handler() }

Using with Hono or other frameworks

Use withServer to intercept SocketQL requests and fall through to your app:

import { Hono } from 'hono'
import { createServer } from '@requence/socketql/server/bun'

const app = new Hono()
const { addSchema, withServer, handler } = createServer({ path: '/ws/' })

addSchema({ typeDefs, resolvers })

export default {
  port: 4000,
  ...handler(),
  fetch: withServer(app.fetch),
}

Context Extension

Extend the GraphQL context per connection:

createServer({
  extendContext: ({ socket }) => ({
    userId: socket.handshake.auth.userId,
  }),
})

Lifecycle Hooks

createServer({
  onConnect: (socket) => {
    console.log('connected:', socket.id)
  },
  onDisconnect: (socket, reason) => {
    console.log('disconnected:', socket.id, reason)
  },
})