@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
104 lines (54 loc) • 1.66 kB
Markdown
---
lang: en
title: 'API docs: socketio.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.socketio.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/socketio](./socketio.md) > [socketio](./socketio.socketio.md)
## socketio namespace
**Signature:**
```typescript
export declare namespace socketio
```
## Functions
<table><thead><tr><th>
Function
</th><th>
Description
</th></tr></thead>
<tbody><tr><td markdown="1">
[connect()](./socketio.socketio.connect.md)
</td><td markdown="1">
Decorate a controller method for `connect`
</td></tr>
<tr><td markdown="1">
[disconnect()](./socketio.socketio.disconnect.md)
</td><td markdown="1">
Decorate a controller method for `disconnect`
</td></tr>
<tr><td markdown="1">
[io()](./socketio.socketio.io.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[namespace(name)](./socketio.socketio.namespace.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[socket()](./socketio.socketio.socket.md)
</td><td markdown="1">
</td></tr>
<tr><td markdown="1">
[subscribe(messageTypes)](./socketio.socketio.subscribe.md)
</td><td markdown="1">
Decorate a method to subscribe to socketio events. For example,
```ts
@socketio.subscribe('chat message')
async function onChat(msg: string) {
}
```
</td></tr>
</tbody></table>