@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
35 lines (22 loc) • 1.22 kB
Markdown
lang: en
title: 'API docs: socketio.socketioserver.use'
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.socketioserver.use.html
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/socketio](./socketio.md) > [SocketIoServer](./socketio.socketioserver.md) > [use](./socketio.socketioserver.use.md)
## SocketIoServer.use() method
Register a sock.io middleware function
<b>Signature:</b>
```typescript
use(fn: SockIOMiddleware): Server<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, any>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| fn | [SockIOMiddleware](./socketio.sockiomiddleware.md) | |
<b>Returns:</b>
Server<import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, import("socket.io/dist/typed-events").DefaultEventsMap, any>