SocketServer | @vuga/real-time

Singleton class For socket.io and express, graphql e.t.c Extending Redis database

Hierarchy

SocketServer

Index

Constructors

constructor

Properties

Accessors

Instance

Methods

Constructors

Private constructor

new SocketServer(): SocketServer

- Defined in socket-server.ts:102
Returns SocketServer

Properties

Private app

app: Application

Private connectedSocket

connectedSocket: any

Private io

io: Server

Private port

port: string | number

Private redisApp

redisApp: createClient = redis.createClient

Private server

server: Server

Private socketpub

socketpub: RedisClient

Private socketsub

socketsub: RedisClient

Static PORT

PORT: number = 3000

Static Private _instance

_instance: SocketServer

Accessors

Static Instance

Instance:

Methods

getApp

getApp(): Application

- Defined in socket-server.ts:109
Get Express Application

Returns Application

getIo

getIo(): Server

- Defined in socket-server.ts:116
Get SocketIO.Server

Returns Server

getSocket

getSocket(): Socket

- Defined in socket-server.ts:123
Get current connected SocketIO.Socket

Returns Socket

init

init(__namedParameters: object): SocketServerOutput

- Defined in socket-server.ts:52
Initialise SocketServer

Parameters
- __namedParameters: object
  - express: object
    - app: Application
    - port: number
  - redis: object
    - ip: string
    - Optional pass?: string
    - Optional port?: number
Returns SocketServerOutput

Generated using TypeDoc