UNPKG

@loopback/docs

Version:

Documentation files rendered at [https://loopback.io](https://loopback.io)

178 lines (83 loc) 2.67 kB
--- lang: en title: 'API docs: socketio.socketiobooter' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/socketio permalink: /doc/en/lb4/apidocs.socketio.socketiobooter.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/socketio](./socketio.md) &gt; [SocketIoBooter](./socketio.socketiobooter.md) ## SocketIoBooter class A class that extends to boot the artifact type. **Signature:** ```typescript export declare class SocketIoBooter extends BaseArtifactBooter ``` **Extends:** BaseArtifactBooter ## Remarks Discovered controllers are bound using [Application.controller()](./core.application.controller.md)<!-- -->. Supported phases: `configure`<!-- -->, `discover`<!-- -->, `load` ## Constructors <table><thead><tr><th> Constructor </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [(constructor)(app, projectRoot, socketioControllerConfig, socketioServer)](./socketio.socketiobooter._constructor_.md) </td><td markdown="1"> </td><td markdown="1"> Constructs a new instance of the `SocketIoBooter` class </td></tr> </tbody></table> ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [app](./socketio.socketiobooter.app.md) </td><td markdown="1"> </td><td markdown="1"> [Application](./core.application.md) </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [socketioControllerConfig](./socketio.socketiobooter.socketiocontrollerconfig.md) </td><td markdown="1"> </td><td markdown="1"> ArtifactOptions </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [socketioServer](./socketio.socketiobooter.socketioserver.md) </td><td markdown="1"> `protected` </td><td markdown="1"> [SocketIoServer](./socketio.socketioserver.md) </td><td markdown="1"> </td></tr> </tbody></table> ## Methods <table><thead><tr><th> Method </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [load()](./socketio.socketiobooter.load.md) </td><td markdown="1"> </td><td markdown="1"> Uses super method to get a list of Artifact classes. Boot each class by binding it to the application using `app.controller(controller);`<!-- -->. </td></tr> </tbody></table>