patterns/websocket

[giscus[bot]]

patterns/websocket

Elysia's WebSocket implementation. Start by declaring WebSocket route with "ws". WebSocket is a realtime protocol for communication between your client and server.

https://elysiajs.com/patterns/websocket

[arthur-eudeline]

Would be nice if beforeHandler() has some examples.
For instance, I'm using it to do verifications in DB and check the user is authenticated. Would be awesome if we could add some data to the context to populate it with user session for example, but the type of Context inside beforeHandler() does not let us add data to it.

[arthur-eudeline]

Also, is there anyway to type the Context content ?

[kravetsone]

Would be nice if beforeHandler() has some examples.
For instance, I'm using it to do verifications in DB and check the user is authenticated. Would be awesome if we could add some data to the context to populate it with user session for example, but the type of Context inside beforeHandler() does not let us add data to it.

Use resolve for this

[kravetsone]

Also, is there anyway to type the Context content ?

You mostly should not reimplantat Elysia smart types in your side

It is useless

[Aniket-Jena-02]

@kravetsone how to use resolve here??

[nightire]

@killerdroid99 Something like this:

export const CollaborationController = new Elysia({
  name: "CollaborationController",
})
  .macro({
    auth: {
      async resolve({ request: { headers }}) {
          const token = headers.get("Authorization")?.split(" ")[1]

          if (isString(token)) {
            const payload = await getSession(token)
        
            if (payload.data) {
              return { token, session: payload.data }
            }
          }
      
          return { token: null, session: null }
        }
      }
  })

  .ws("/collaboration/", {
    auth: true,

    async open(ws) {
      const { session } = ws.data

      if (isNull(session)) {
        return ws.close(1008, "Unauthorized")
      }
    },
  })

Note: there's no way to access the ws object within the resolve callback, so you have to check the session in open handler (or other handlers) by yourself.

[ArifulProtik]

import type { Context, ServerWebSocket } from 'elysia'

export type myWs = ServerWebSocket<{ id: string; data: Context }>

where do i import ServerWebSocket from? While Elysia Preach full type safety. I am really struggling here just to determine Type, Documentation is incomplete,

Module "elysia" has no exported member ServerWebSocket. And Default Import Does give some wired error
Type '{ id: string; data: { body: unknown; query: Record<string, string>; params: Record<string, string>; headers: Record<string, string | undefined>; cookie: Record<string, Cookie>; ... 7 more ...; status: <const Code extends number | keyof StatusMap, const T = Code extends 100 | ... 59 more ... | 511 ? { ...; }...' does not satisfy the constraint 'string'.

[Abdullah05-js]

is there a way to get all the connections to my ws server