Page Contents
Home > @loopback/socketio > SocketIoBooter
SocketIoBooter class
A class that extends to boot the artifact type.
Signature:
export declare class SocketIoBooter extends BaseArtifactBooter
Extends: BaseArtifactBooter
Remarks
Discovered controllers are bound using Application.controller().
Supported phases: configure, discover, load
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| [(constructor)(app, projectRoot, socketioControllerConfig, socketioServer)](/doc/en/lb4/apidocs.socketio.socketiobooter._constructor_.html) | Constructs a new instance of the `SocketIoBooter` class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| [app](/doc/en/lb4/apidocs.socketio.socketiobooter.app.html) | [Application](/doc/en/lb4/apidocs.core.application.html) | ||
| [socketioControllerConfig](/doc/en/lb4/apidocs.socketio.socketiobooter.socketiocontrollerconfig.html) | ArtifactOptions | ||
| [socketioServer](/doc/en/lb4/apidocs.socketio.socketiobooter.socketioserver.html) | `protected` | [SocketIoServer](/doc/en/lb4/apidocs.socketio.socketioserver.html) |
Methods
| Method | Modifiers | Description |
|---|---|---|
| [load()](/doc/en/lb4/apidocs.socketio.socketiobooter.load.html) | Uses super method to get a list of Artifact classes. Boot each class by binding it to the application using `app.controller(controller);`. |