@fkn/lib/websocket
Classes
Section titled “Classes”WebSocket
Section titled “WebSocket”The platform’s WebSocket, opened by FKN’s proxy on the node the session uses: the server sees that node’s address,
never the person’s, and the proxy applies its egress validation, fair-use limits and metering as for a fetch. Its
messages pass through the proxy’s memory, so it is for servers the browser should not reach from its own address.
It behaves as the platform’s, events and their order included, with what the platform also refuses: a url that is
not ws:, wss:, http: or https:, a fragment, a protocol that is not a token or is offered twice. It also
refuses FKN’s own hosts and a protocol named fkn-proxy or starting fkn-proxy., which carry the target to the
proxy. Nothing reconnects by itself. A Worker needs relayWorker from its page first; without it the socket fails
once the broker has not answered within the deadline of apiWithin. extensions is always empty.
Extends
Section titled “Extends”EventTarget
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new WebSocket(url, protocols?): WebSocket;Parameters
Section titled “Parameters”string | URL
protocols?
Section titled “protocols?”string | string[]
Returns
Section titled “Returns”Overrides
Section titled “Overrides”EventTarget.constructorProperties
Section titled “Properties”CLOSED
Section titled “CLOSED”readonly CLOSED: 3;CLOSING
Section titled “CLOSING”readonly CLOSING: 2;CONNECTING
Section titled “CONNECTING”readonly CONNECTING: 0;extensions
Section titled “extensions”readonly extensions: "" = '';readonly OPEN: 1;readonly url: string;CLOSED
Section titled “CLOSED”readonly static CLOSED: 3;CLOSING
Section titled “CLOSING”readonly static CLOSING: 2;CONNECTING
Section titled “CONNECTING”readonly static CONNECTING: 0;readonly static OPEN: 1;Accessors
Section titled “Accessors”binaryType
Section titled “binaryType”Get Signature
Section titled “Get Signature”get binaryType(): BinaryType;Returns
Section titled “Returns”BinaryType
Set Signature
Section titled “Set Signature”set binaryType(type): void;Parameters
Section titled “Parameters”BinaryType
Returns
Section titled “Returns”void
bufferedAmount
Section titled “bufferedAmount”Get Signature
Section titled “Get Signature”get bufferedAmount(): number;Returns
Section titled “Returns”number
onclose
Section titled “onclose”Get Signature
Section titled “Get Signature”get onclose(): Handler<CloseEvent>;Returns
Section titled “Returns”Handler<CloseEvent>
Set Signature
Section titled “Set Signature”set onclose(handler): void;Parameters
Section titled “Parameters”handler
Section titled “handler”Handler<CloseEvent>
Returns
Section titled “Returns”void
onerror
Section titled “onerror”Get Signature
Section titled “Get Signature”get onerror(): Handler<Event>;Returns
Section titled “Returns”Handler<Event>
Set Signature
Section titled “Set Signature”set onerror(handler): void;Parameters
Section titled “Parameters”handler
Section titled “handler”Handler<Event>
Returns
Section titled “Returns”void
onmessage
Section titled “onmessage”Get Signature
Section titled “Get Signature”get onmessage(): Handler<MessageEvent<any>>;Returns
Section titled “Returns”Handler<MessageEvent<any>>
Set Signature
Section titled “Set Signature”set onmessage(handler): void;Parameters
Section titled “Parameters”handler
Section titled “handler”Handler<MessageEvent<any>>
Returns
Section titled “Returns”void
onopen
Section titled “onopen”Get Signature
Section titled “Get Signature”get onopen(): Handler<Event>;Returns
Section titled “Returns”Handler<Event>
Set Signature
Section titled “Set Signature”set onopen(handler): void;Parameters
Section titled “Parameters”handler
Section titled “handler”Handler<Event>
Returns
Section titled “Returns”void
protocol
Section titled “protocol”Get Signature
Section titled “Get Signature”get protocol(): string;Returns
Section titled “Returns”string
readyState
Section titled “readyState”Get Signature
Section titled “Get Signature”get readyState(): 0 | 1 | 2 | 3;Returns
Section titled “Returns”0 | 1 | 2 | 3
Methods
Section titled “Methods”addEventListener()
Section titled “addEventListener()”Call Signature
Section titled “Call Signature”addEventListener<K>( type, listener, options?): void;Type Parameters
Section titled “Type Parameters”K extends keyof WebSocketEventMap
Parameters
Section titled “Parameters”K
listener
Section titled “listener”(this, ev) => any
options?
Section titled “options?”boolean | AddEventListenerOptions
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”EventTarget.addEventListenerCall Signature
Section titled “Call Signature”addEventListener( type, listener, options?): void;Parameters
Section titled “Parameters”string
listener
Section titled “listener”EventListenerOrEventListenerObject
options?
Section titled “options?”boolean | AddEventListenerOptions
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”EventTarget.addEventListenerclose()
Section titled “close()”close(code?, reason?): void;Parameters
Section titled “Parameters”number
reason?
Section titled “reason?”string
Returns
Section titled “Returns”void
removeEventListener()
Section titled “removeEventListener()”Call Signature
Section titled “Call Signature”removeEventListener<K>( type, listener, options?): void;Type Parameters
Section titled “Type Parameters”K extends keyof WebSocketEventMap
Parameters
Section titled “Parameters”K
listener
Section titled “listener”(this, ev) => any
options?
Section titled “options?”boolean | EventListenerOptions
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”EventTarget.removeEventListenerCall Signature
Section titled “Call Signature”removeEventListener( type, listener, options?): void;Parameters
Section titled “Parameters”string
listener
Section titled “listener”EventListenerOrEventListenerObject
options?
Section titled “options?”boolean | EventListenerOptions
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”EventTarget.removeEventListenersend()
Section titled “send()”send(data): void;Parameters
Section titled “Parameters”string | Blob | ArrayBufferLike | ArrayBufferView<ArrayBufferLike>
Returns
Section titled “Returns”void