API docs: socketio.socketioserver | LoopBack Documentation

Page Contents

SocketIoServer class

A socketio server

Signature:

export declare class SocketIoServer extends Context 

Extends: Context

Constructor	Modifiers	Description
(constructor)(app, options)		Constructs a new instance of the `SocketIoServer` class

Property	Modifiers	Type
app		Application
config	`readonly`	HttpServerResolvedOptions
listening	`readonly`	boolean
options	`protected`	SocketIoServerOptions
url	`readonly`	string

Method	Modifiers	Description
controller(controllerClass)		Register a socket.io controller
discoverAndRegister()		Discover all socket.io controllers and register routes
route(controllerClass, meta)		Register a socketio controller
start()		Start the socketio server
stop()		Stop the socketio server
use(fn)		Register a sock.io middleware function