Interface SocketSpec

interface SocketSpec {
    id: string;
    mount?: "module" | "root";
    path: string;
    summary: string;
}

Index

Properties

id mount? path summary

Properties

`Readonly`id

id: string

`Optional` `Readonly`mount

mount?: "module" | "root"

root is for previously shipped paths (/ws/chat); the host rejects collisions, as for routes.

`Readonly`path

path: string

Starts with /; a WebSocket upgrade is a GET, mounted under /api/<module id>, or at the root for mount: "root".

`Readonly`summary

summary: string