Page Contents

Home > @loopback/socketio

socketio package

@loopback/socketio

Classes

Class Description
[DefaultSocketIoSequence](/doc/en/lb4/apidocs.socketio.defaultsocketiosequence.html)
[SocketIoApplication](/doc/en/lb4/apidocs.socketio.socketioapplication.html)
[SocketIoBooter](/doc/en/lb4/apidocs.socketio.socketiobooter.html) A class that extends to boot the artifact type.
[SocketIoComponent](/doc/en/lb4/apidocs.socketio.socketiocomponent.html)
[SocketIoConnectionContext](/doc/en/lb4/apidocs.socketio.socketioconnectioncontext.html) Request context for a socket.io request
[SocketIoControllerFactory](/doc/en/lb4/apidocs.socketio.socketiocontrollerfactory.html) A factory to instantiate socket.io controllers
[SocketIoInvokeMethodProvider](/doc/en/lb4/apidocs.socketio.socketioinvokemethodprovider.html)
[SocketIoRejectProvider](/doc/en/lb4/apidocs.socketio.socketiorejectprovider.html)
[SocketIoSendProvider](/doc/en/lb4/apidocs.socketio.socketiosendprovider.html)
[SocketIoServer](/doc/en/lb4/apidocs.socketio.socketioserver.html) A socketio server

Functions

Function Description
[getNamespaceKeyForName(name)](/doc/en/lb4/apidocs.socketio.getnamespacekeyforname.html)
[getSocketIoMetadata(controllerClass)](/doc/en/lb4/apidocs.socketio.getsocketiometadata.html)
[socketio(spec)](/doc/en/lb4/apidocs.socketio.socketio.html) Decorate a socketio controller class to specify the namespace.

Interfaces

Interface Description
[HttpServerResolvedOptions](/doc/en/lb4/apidocs.socketio.httpserverresolvedoptions.html) Valid configuration for the HttpServer constructor.
[SocketIoMetadata](/doc/en/lb4/apidocs.socketio.socketiometadata.html) Metadata for SocketIo
[SocketIoSequence](/doc/en/lb4/apidocs.socketio.socketiosequence.html)
[SocketIoServerOptions](/doc/en/lb4/apidocs.socketio.socketioserveroptions.html)

Namespaces

Namespace Description
[socketio](/doc/en/lb4/apidocs.socketio.socketio.html)
[SocketIoBindings](/doc/en/lb4/apidocs.socketio.socketiobindings.html)
[SocketIoTags](/doc/en/lb4/apidocs.socketio.socketiotags.html)

Variables

Variable Description
[ERR\_NO\_MULTI\_SERVER](/doc/en/lb4/apidocs.socketio.err_no_multi_server.html)
[SOCKET\_IO\_CONNECT\_METADATA](/doc/en/lb4/apidocs.socketio.socket_io_connect_metadata.html)
[SOCKET\_IO\_METADATA](/doc/en/lb4/apidocs.socketio.socket_io_metadata.html)
[SOCKET\_IO\_SUBSCRIBE\_METADATA](/doc/en/lb4/apidocs.socketio.socket_io_subscribe_metadata.html)
[SocketIoControllerDefaults](/doc/en/lb4/apidocs.socketio.socketiocontrollerdefaults.html) Default ArtifactOptions for SocketIoControllerBooter.
[socketIoControllers](/doc/en/lb4/apidocs.socketio.socketiocontrollers.html) A binding filter to match socket.io controllers

Type Aliases

Type Alias Description
[SocketIoDoneFunction](/doc/en/lb4/apidocs.socketio.socketiodonefunction.html)
[SocketIoInvokeMethod](/doc/en/lb4/apidocs.socketio.socketioinvokemethod.html)
[SocketIoOptions](/doc/en/lb4/apidocs.socketio.socketiooptions.html)
[SocketIoRejectMethod](/doc/en/lb4/apidocs.socketio.socketiorejectmethod.html)
[SocketIoSendMethod](/doc/en/lb4/apidocs.socketio.socketiosendmethod.html)
[SockIOMiddleware](/doc/en/lb4/apidocs.socketio.sockiomiddleware.html)