Presence | @vuga/real-time

Hierarchy

Presence

Index

Constructors

constructor

Properties

Accessors

Instance

Methods

Constructors

Private constructor

new Presence(): Presence

- Defined in redis-presence.ts:16
Returns Presence

Properties

client

client: RedisClient

clientSub

clientSub: RedisClient

presenceKey

presenceKey: string = "redis-presence"

Static Private _instance

_instance: Presence

Accessors

Static Instance

Instance:

Methods

clean

clean(toDelete: any[]): void

- Defined in redis-presence.ts:174
Parameters
- toDelete: any[]
Returns void

get

get(connectionId: string): Promise<object>

- Defined in redis-presence.ts:120
Parameters
- connectionId: string
Returns Promise<object>

init

init(redisIP: string, redisPort: number, redisPassword: string, presenceKey: string): void

- Defined in redis-presence.ts:20
Parameters
- redisIP: string
- redisPort: number
- redisPassword: string
- presenceKey: string
Returns void

list

list(): Promise<any>

- Defined in redis-presence.ts:143
list

Returns Promise<any>

remove

remove(connectionId: string): Promise<string>

- Defined in redis-presence.ts:107
Removes a presence in redis

Parameters
- connectionId: string
Returns Promise<string>

update

update(connectionId: string, meta: any): Promise<any>

- Defined in redis-presence.ts:73
Update client data here

Parameters
- connectionId: string
- meta: any
Returns Promise<any>

upsert

upsert(connectionId: string, meta: string): Promise<string>

- Defined in redis-presence.ts:50
Insert data into redis

Parameters
- connectionId: string
- meta: string
Returns Promise<string>

Generated using TypeDoc