---
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

<table><thead><tr><th>

Class


</th><th>

Description


</th></tr></thead>
<tbody><tr><td markdown="1">

[DefaultSocketIoSequence](./socketio.defaultsocketiosequence.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SocketIoApplication](./socketio.socketioapplication.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SocketIoBooter](./socketio.socketiobooter.md)


</td><td markdown="1">

A class that extends  to boot the  artifact type.


</td></tr>
<tr><td markdown="1">

[SocketIoComponent](./socketio.socketiocomponent.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SocketIoConnectionContext](./socketio.socketioconnectioncontext.md)


</td><td markdown="1">

Request context for a socket.io request


</td></tr>
<tr><td markdown="1">

[SocketIoControllerFactory](./socketio.socketiocontrollerfactory.md)


</td><td markdown="1">

A factory to instantiate socket.io controllers


</td></tr>
<tr><td markdown="1">

[SocketIoInvokeMethodProvider](./socketio.socketioinvokemethodprovider.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SocketIoRejectProvider](./socketio.socketiorejectprovider.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SocketIoSendProvider](./socketio.socketiosendprovider.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SocketIoServer](./socketio.socketioserver.md)


</td><td markdown="1">

A socketio server


</td></tr>
</tbody></table>

## Functions

<table><thead><tr><th>

Function


</th><th>

Description


</th></tr></thead>
<tbody><tr><td markdown="1">

[getNamespaceKeyForName(name)](./socketio.getnamespacekeyforname.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[getSocketIoMetadata(controllerClass)](./socketio.getsocketiometadata.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[socketio(spec)](./socketio.socketio.md)


</td><td markdown="1">

Decorate a socketio controller class to specify the namespace.


</td></tr>
</tbody></table>

## Interfaces

<table><thead><tr><th>

Interface


</th><th>

Description


</th></tr></thead>
<tbody><tr><td markdown="1">

[HttpServerResolvedOptions](./socketio.httpserverresolvedoptions.md)


</td><td markdown="1">

Valid configuration for the HttpServer constructor.


</td></tr>
<tr><td markdown="1">

[SocketIoMetadata](./socketio.socketiometadata.md)


</td><td markdown="1">

Metadata for SocketIo


</td></tr>
<tr><td markdown="1">

[SocketIoSequence](./socketio.socketiosequence.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SocketIoServerOptions](./socketio.socketioserveroptions.md)


</td><td markdown="1">


</td></tr>
</tbody></table>

## Namespaces

<table><thead><tr><th>

Namespace


</th><th>

Description


</th></tr></thead>
<tbody><tr><td markdown="1">

[socketio](./socketio.socketio.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SocketIoBindings](./socketio.socketiobindings.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SocketIoTags](./socketio.socketiotags.md)


</td><td markdown="1">


</td></tr>
</tbody></table>

## Variables

<table><thead><tr><th>

Variable


</th><th>

Description


</th></tr></thead>
<tbody><tr><td markdown="1">

[ERR\_NO\_MULTI\_SERVER](./socketio.err_no_multi_server.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SOCKET\_IO\_CONNECT\_METADATA](./socketio.socket_io_connect_metadata.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SOCKET\_IO\_METADATA](./socketio.socket_io_metadata.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SOCKET\_IO\_SUBSCRIBE\_METADATA](./socketio.socket_io_subscribe_metadata.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SocketIoControllerDefaults](./socketio.socketiocontrollerdefaults.md)


</td><td markdown="1">

Default ArtifactOptions for SocketIoControllerBooter.


</td></tr>
<tr><td markdown="1">

[socketIoControllers](./socketio.socketiocontrollers.md)


</td><td markdown="1">

A binding filter to match socket.io controllers


</td></tr>
</tbody></table>

## Type Aliases

<table><thead><tr><th>

Type Alias


</th><th>

Description


</th></tr></thead>
<tbody><tr><td markdown="1">

[SocketIoDoneFunction](./socketio.socketiodonefunction.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SocketIoInvokeMethod](./socketio.socketioinvokemethod.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SocketIoOptions](./socketio.socketiooptions.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SocketIoRejectMethod](./socketio.socketiorejectmethod.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SocketIoSendMethod](./socketio.socketiosendmethod.md)


</td><td markdown="1">


</td></tr>
<tr><td markdown="1">

[SockIOMiddleware](./socketio.sockiomiddleware.md)


</td><td markdown="1">


</td></tr>
</tbody></table>