Class ServerApp

Index

Constructors

Accessors

activeNamespaces currentNamespaces events namespaces server

Methods

adapter add addOnConnection addOnDisconnect build close destroy getEvents getNamespace getNamespaces getPaths getServer link onConnection onDisconnect use

Constructors

constructor

new ServerApp(namespaces?: string | string[]): ServerApp
Parameters
- Optionalnamespaces: string | string[]
  Limits application to some namespaces.
Returns ServerApp
- Defined in app.ts:20

Accessors

activeNamespaces

get activeNamespaces(): string[]
Returns string[]
- Defined in app.ts:34

currentNamespaces

get currentNamespaces(): string[]
Returns string[]
- Defined in app.ts:38

events

get events(): Record<string, ListenerBuilderJson[]>
Returns Record<string, ListenerBuilderJson[]>
- Defined in app.ts:26

namespaces

get namespaces(): string[]
Returns string[]
- Defined in app.ts:30

server

get server(): | Server<
    DefaultEventsMap,
    DefaultEventsMap,
    DefaultEventsMap,
    any,
>
| undefined
In case you need to do something that this lib cannot do. (e.g.: socket.io v4.x.x methods)

Returns Server<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any> | undefined
- Defined in app.ts:46

Methods

adapter

adapter(): ServerApp
Returns ServerApp
- Defined in app.ts:242
adapter(v: typeof Adapter): ServerApp
Parameters
- v: typeof Adapter
Returns ServerApp
- Defined in app.ts:243
adapter(v: (nsp: Namespace) => Adapter): ServerApp
Parameters
- v: (nsp: Namespace) => Adapter
Returns ServerApp
- Defined in app.ts:244
adapter(v: typeof Adapter | ((nsp: Namespace) => Adapter)): ServerApp
Parameters
- v: typeof Adapter | ((nsp: Namespace) => Adapter)
Returns ServerApp
- Defined in app.ts:245

add

add<DataType, ErrorType>(
name: string,
...fn: Controller<DataType, ErrorType>[],
): ServerApp
Type Parameters
- DataType
- ErrorType
Parameters
- name: string
- ...fn: Controller<DataType, ErrorType>[]
Returns ServerApp
Description
Add listener (event)
- Defined in app.ts:79
add<DataType, ErrorType>(
name: ListenerBuilderSettings,
...fn: Controller<DataType, ErrorType>[],
): ServerApp
Type Parameters
- DataType
- ErrorType
Parameters
- name: ListenerBuilderSettings
- ...fn: Controller<DataType, ErrorType>[]
Returns ServerApp
Description
Add listener (event)
- Defined in app.ts:80
add(...fn: ListenerBuilder<unknown, unknown>[]): ServerApp
Parameters
- ...fn: ListenerBuilder<unknown, unknown>[]
Returns ServerApp
Description
Add listener (event)
- Defined in app.ts:81
add(...fn: ListenerBuilder<unknown, unknown>[][]): ServerApp
Parameters
- ...fn: ListenerBuilder<unknown, unknown>[][]
Returns ServerApp
Description
Add listener (event)
- Defined in app.ts:82
add(...fn: SocketMiddleware[]): ServerApp
Parameters
- ...fn: SocketMiddleware[]
Returns ServerApp
Description
NspBuilder.addMiddlewares
- Defined in app.ts:86
add(...fn: SocketMiddleware[][]): ServerApp
Parameters
- ...fn: SocketMiddleware[][]
Returns ServerApp
Description
Add listener (event)
- Defined in app.ts:87
add(...fn: NspBuilder[]): ServerApp
Parameters
- ...fn: NspBuilder[]
Returns ServerApp
Description
NspBuilder.link
- Defined in app.ts:91
add(namespace: string, ...fn: NspBuilder[]): ServerApp
Parameters
- namespace: string
- ...fn: NspBuilder[]
Returns ServerApp
Description
Add listener (event)
- Defined in app.ts:92
add(...fn: NspBuilder[][]): ServerApp
Parameters
- ...fn: NspBuilder[][]
Returns ServerApp
Description
Add listener (event)
- Defined in app.ts:93

addOnConnection

addOnConnection(
...fn: ((socket: Socket, nsp: Namespace, server: Server) => void)[],
): ServerApp
Parameters
- ...fn: ((socket: Socket, nsp: Namespace, server: Server) => void)[]
Returns ServerApp
- Defined in app.ts:297
addOnConnection(
fn: ((socket: Socket, nsp: Namespace, server: Server) => void)[],
): ServerApp
Parameters
- fn: ((socket: Socket, nsp: Namespace, server: Server) => void)[]
Returns ServerApp
- Defined in app.ts:298

addOnDisconnect

addOnDisconnect(
    ...fn: (
        (
            reason: string,
            socket: Socket,
            nsp: Namespace,
            server: Server,
        ) => void
    )[],
): ServerApp
Parameters
- ...fn: ((reason: string, socket: Socket, nsp: Namespace, server: Server) => void)[]
Returns ServerApp
- Defined in app.ts:324
addOnDisconnect(
    fn: (
        (
            reason: string,
            socket: Socket,
            nsp: Namespace,
            server: Server,
        ) => void
    )[],
): ServerApp
Parameters
- fn: ((reason: string, socket: Socket, nsp: Namespace, server: Server) => void)[]
Returns ServerApp
- Defined in app.ts:325

build

build(opts?: Partial<ServerOptions>): ServerApp
Parameters
- Optionalopts: Partial<ServerOptions>
Returns ServerApp
- Defined in app.ts:187
build(
srv?: number | Server<typeof IncomingMessage, typeof ServerResponse>,
opts?: Partial<ServerOptions>,
): ServerApp
Parameters
- Optionalsrv: number | Server<typeof IncomingMessage, typeof ServerResponse>
- Optionalopts: Partial<ServerOptions>
Returns ServerApp
- Defined in app.ts:188
build(
    srv:
        | number
        | Partial<ServerOptions>
        | Server<typeof IncomingMessage, typeof ServerResponse>
        | undefined,
    opts?: Partial<ServerOptions>,
): ServerApp
Parameters
- srv:
      | number
      | Partial<ServerOptions>
      | Server<typeof IncomingMessage, typeof ServerResponse>
      | undefined
- Optionalopts: Partial<ServerOptions>
Returns ServerApp
- Defined in app.ts:189

close

close(): Promise<void>
Closes the Socket.IO server.

Note: this also closes the underlying HTTP server.

Returns Promise<void>
- Defined in app.ts:262
close(fn: (err?: Error) => void): void
Closes the Socket.IO server.

Note: this also closes the underlying HTTP server.
Parameters
- fn: (err?: Error) => void
Returns void
- Defined in app.ts:263

destroy

destroy(): ServerApp
Returns ServerApp
- Defined in app.ts:225

getEvents

getEvents(): Record<string, ListenerBuilderJson[]>
Returns Record<string, ListenerBuilderJson[]>
- Defined in app.ts:151

getNamespace

getNamespace(
    name?: string,
):
    | Namespace<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>
    | undefined
Parameters
- name: string = '/'
  Default: '/'
Returns Namespace<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any> | undefined
- Defined in app.ts:171

getNamespaces

getNamespaces(): string[]
Returns string[]
- Defined in app.ts:179

getPaths

getPaths(): string[]
Returns string[]
- Defined in app.ts:139

getServer

getServer(): | Server<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>
| undefined
In case you need to do something that this lib cannot do. (e.g.: socket.io v4.x.x methods)

Returns Server<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any> | undefined
- Defined in app.ts:343

link

link(...fn: NspBuilder[]): ServerApp
Parameters
- ...fn: NspBuilder[]
Returns ServerApp
- Defined in app.ts:126
link(...fn: NspBuilder[][]): ServerApp
Parameters
- ...fn: NspBuilder[][]
Returns ServerApp
- Defined in app.ts:127
link(namespace: string, ...fn: NspBuilder[]): ServerApp
Parameters
- namespace: string
- ...fn: NspBuilder[]
Returns ServerApp
- Defined in app.ts:128
link(namespace: string, ...fn: NspBuilder[][]): ServerApp
Parameters
- namespace: string
- ...fn: NspBuilder[][]
Returns ServerApp
- Defined in app.ts:129
link(
name: string | NspBuilder | NspBuilder[],
...fn: (NspBuilder | NspBuilder[])[],
): ServerApp
Parameters
- name: string | NspBuilder | NspBuilder[]
- ...fn: (NspBuilder | NspBuilder[])[]
Returns ServerApp
- Defined in app.ts:130

onConnection

onConnection(
...fn: ((socket: Socket, nsp: Namespace, server: Server) => void)[],
): ServerApp
Parameters
- ...fn: ((socket: Socket, nsp: Namespace, server: Server) => void)[]
Returns ServerApp
- Defined in app.ts:285
onConnection(
fn: ((socket: Socket, nsp: Namespace, server: Server) => void)[],
): ServerApp
Parameters
- fn: ((socket: Socket, nsp: Namespace, server: Server) => void)[]
Returns ServerApp
- Defined in app.ts:286

onDisconnect

onDisconnect(
    ...fn: (
        (
            reason: string,
            socket: Socket,
            nsp: Namespace,
            server: Server,
        ) => void
    )[],
): ServerApp
Parameters
- ...fn: ((reason: string, socket: Socket, nsp: Namespace, server: Server) => void)[]
Returns ServerApp
- Defined in app.ts:309
onDisconnect(
    fn: (
        (
            reason: string,
            socket: Socket,
            nsp: Namespace,
            server: Server,
        ) => void
    )[],
): ServerApp
Parameters
- fn: ((reason: string, socket: Socket, nsp: Namespace, server: Server) => void)[]
Returns ServerApp
- Defined in app.ts:310

use

use(...fn: Middleware[]): ServerApp
Parameters
- ...fn: Middleware[]
Returns ServerApp
- Defined in app.ts:119
use(fn: Middleware[]): ServerApp
Parameters
- fn: Middleware[]
Returns ServerApp
- Defined in app.ts:120

Class ServerApp

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ServerApp

Accessors

activeNamespaces

Returns string[]

currentNamespaces

Returns string[]

events

Returns Record<string, ListenerBuilderJson[]>

namespaces

Returns string[]

server

Returns Server<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any> | undefined

Methods

adapter

Returns ServerApp

Parameters

Returns ServerApp

Parameters

Returns ServerApp

Parameters

Returns ServerApp

add

Type Parameters

Parameters

Returns ServerApp

Description

Type Parameters

Parameters

Returns ServerApp

Description

Parameters

Returns ServerApp

Description

Parameters

Returns ServerApp

Description

Parameters

Returns ServerApp

Description

Parameters

Returns ServerApp

Description

Parameters

Returns ServerApp

Description

Parameters

Returns ServerApp

Description

Parameters

Returns ServerApp

Description

addOnConnection

Parameters

Returns ServerApp

Parameters

Returns ServerApp

addOnDisconnect

Parameters

Returns ServerApp

Parameters

Returns ServerApp

build

Parameters

Returns ServerApp

Parameters

Returns ServerApp

Parameters

Returns ServerApp

close

Returns Promise<void>

Parameters

Returns void