Page Contents

Home > @loopback/socketio

socketio package

@loopback/socketio

Classes

Class Description

DefaultSocketIoSequence

SocketIoApplication

SocketIoBooter

A class that extends to boot the artifact type.

SocketIoComponent

SocketIoConnectionContext

Request context for a socket.io request

SocketIoControllerFactory

A factory to instantiate socket.io controllers

SocketIoInvokeMethodProvider

SocketIoRejectProvider

SocketIoSendProvider

SocketIoServer

A socketio server

Functions

Function Description

getNamespaceKeyForName(name)

getSocketIoMetadata(controllerClass)

socketio(spec)

Decorate a socketio controller class to specify the namespace.

Interfaces

Interface Description

HttpServerResolvedOptions

Valid configuration for the HttpServer constructor.

SocketIoMetadata

Metadata for SocketIo

SocketIoSequence

SocketIoServerOptions

Namespaces

Namespace Description

socketio

SocketIoBindings

SocketIoTags

Variables

Variable Description

ERR_NO_MULTI_SERVER

SOCKET_IO_CONNECT_METADATA

SOCKET_IO_METADATA

SOCKET_IO_SUBSCRIBE_METADATA

SocketIoControllerDefaults

Default ArtifactOptions for SocketIoControllerBooter.

socketIoControllers

A binding filter to match socket.io controllers

Type Aliases

Type Alias Description

SocketIoDoneFunction

SocketIoInvokeMethod

SocketIoOptions

SocketIoRejectMethod

SocketIoSendMethod

SockIOMiddleware