Class PresenceTracker<T>

Type Parameters

T = Record<string, unknown>

Index

Methods

create heartbeat remove tick get has list count staleCount getTimeoutMs setTimeoutMs clear

Methods

`Static`create

create<T = Record<string, unknown>>(opts?: PresenceOptions): PresenceTracker<T>
Type Parameters
- T = Record<string, unknown>
Parameters
- opts: PresenceOptions = {}
Returns PresenceTracker<T>
- Defined in runtime/presence-tracker.ts:61

heartbeat

heartbeat(id: string, data: T | undefined, now: number): PresenceEntry<T> | null
Parameters
- id: string
- data: T | undefined
- now: number
Returns PresenceEntry<T> | null
- Defined in runtime/presence-tracker.ts:69

remove

remove(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/presence-tracker.ts:95

tick

tick(now: number): string[]
Parameters
- now: number
Returns string[]
- Defined in runtime/presence-tracker.ts:101

get

get(id: string): PresenceEntry<T> | null
Parameters
- id: string
Returns PresenceEntry<T> | null
- Defined in runtime/presence-tracker.ts:120

has

has(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/presence-tracker.ts:125

list

list(): PresenceEntry<T>[]
Returns PresenceEntry<T>[]
- Defined in runtime/presence-tracker.ts:130

count

count(): number
Returns number
- Defined in runtime/presence-tracker.ts:141

staleCount

staleCount(now: number): number
Parameters
- now: number
Returns number
- Defined in runtime/presence-tracker.ts:144

getTimeoutMs

getTimeoutMs(): number
Returns number
- Defined in runtime/presence-tracker.ts:157

setTimeoutMs

setTimeoutMs(ms: number): void
Parameters
- ms: number
Returns void
- Defined in runtime/presence-tracker.ts:158

clear

clear(): void
Returns void
- Defined in runtime/presence-tracker.ts:162