UNPKG

@loopback/docs

Version:

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

github.com/loopbackio/loopback-next/tree/master/docs

loopbackio/loopback-next

81 lines (62 loc) • 3.51 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
--- lang: en title: 'API docs: socketio' 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.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/socketio](./socketio.md) ## socketio package [@loopback/socketio](https://github.com/loopbackio/loopback-next/tree/master/extensions/socketio) ## Classes | Class | Description | | --- | --- | | [DefaultSocketIoSequence](./socketio.defaultsocketiosequence.md) | | | [SocketIoApplication](./socketio.socketioapplication.md) | | | [SocketIoBooter](./socketio.socketiobooter.md) | A class that extends [BaseArtifactBooter](./boot.baseartifactbooter.md) to boot the artifact type. | | [SocketIoComponent](./socketio.socketiocomponent.md) | | | [SocketIoConnectionContext](./socketio.socketioconnectioncontext.md) | Request context for a socket.io request | | [SocketIoControllerFactory](./socketio.socketiocontrollerfactory.md) | A factory to instantiate socket.io controllers | | [SocketIoInvokeMethodProvider](./socketio.socketioinvokemethodprovider.md) | | | [SocketIoRejectProvider](./socketio.socketiorejectprovider.md) | | | [SocketIoSendProvider](./socketio.socketiosendprovider.md) | | | [SocketIoServer](./socketio.socketioserver.md) | A socketio server | ## Functions | Function | Description | | --- | --- | | [getSocketIoMetadata(controllerClass)](./socketio.getsocketiometadata.md) | | | [socketio(spec)](./socketio.socketio.md) | Decorate a socketio controller class to specify the namespace. | ## Interfaces | Interface | Description | | --- | --- | | [HttpServerResolvedOptions](./socketio.httpserverresolvedoptions.md) | Valid configuration for the HttpServer constructor. | | [SocketIoMetadata](./socketio.socketiometadata.md) | Metadata for SocketIo | | [SocketIoSequence](./socketio.socketiosequence.md) | | | [SocketIoServerOptions](./socketio.socketioserveroptions.md) | | ## Namespaces | Namespace | Description | | --- | --- | | [socketio](./socketio.socketio.md) | | | [SocketIoBindings](./socketio.socketiobindings.md) | | | [SocketIoTags](./socketio.socketiotags.md) | | ## Variables | Variable | Description | | --- | --- | | [ERR\_NO\_MULTI\_SERVER](./socketio.err_no_multi_server.md) | | | [getNamespaceKeyForName](./socketio.getnamespacekeyforname.md) | | | [SOCKET\_IO\_CONNECT\_METADATA](./socketio.socket_io_connect_metadata.md) | | | [SOCKET\_IO\_METADATA](./socketio.socket_io_metadata.md) | | | [SOCKET\_IO\_SUBSCRIBE\_METADATA](./socketio.socket_io_subscribe_metadata.md) | | | [SocketIoControllerDefaults](./socketio.socketiocontrollerdefaults.md) | Default ArtifactOptions for SocketIoControllerBooter. | | [socketIoControllers](./socketio.socketiocontrollers.md) | A binding filter to match socket.io controllers | ## Type Aliases | Type Alias | Description | | --- | --- | | [SocketIoDoneFunction](./socketio.socketiodonefunction.md) | | | [SocketIoInvokeMethod](./socketio.socketioinvokemethod.md) | | | [SocketIoOptions](./socketio.socketiooptions.md) | | | [SocketIoRejectMethod](./socketio.socketiorejectmethod.md) | | | [SocketIoSendMethod](./socketio.socketiosendmethod.md) | | | [SockIOMiddleware](./socketio.sockiomiddleware.md) | |