Class Presence<T>

Typed Emitter from: https://github.com/binier/tiny-typed-emitter/

MIT License Copyright (c) 2020 Zurab Benashvili (binier) zura.bena@gmail.com

Type Parameters

T = any

Hierarchy (view full)

TypedEmitter<PresenceEventMap<T>>
- Presence

Constructors

constructor

new Presence<T>(): Presence<T>
Type Parameters
- T = any
Returns Presence<T>
Inherited from TypedEmitter.constructor

Properties

channel

channel: string

connection

connection: string

localPresences

localPresences: Record<string, LocalPresence<T>>

remotePresences

remotePresences: Record<string, T>

subscribed

subscribed: boolean

wantSubscribe

wantSubscribe: boolean

`Static` defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener<U>(event, listener): this
Type Parameters
- U extends keyof PresenceEventMap<T>
Parameters
- event: U
- listener: PresenceEventMap<T>[U]
Returns this
Inherited from TypedEmitter.addListener
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:363

create

create(id?): LocalPresence<T>
Parameters
- Optional id: string
Returns LocalPresence<T>
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:260

destroy

destroy(callback?): void
Parameters
- Optional callback: Callback
Returns void
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:261

emit

emit<U>(event, ...args): boolean
Type Parameters
- U extends keyof PresenceEventMap<T>
Parameters
- event: U
- Rest ...args: Parameters<PresenceEventMap<T>[U]>
Returns boolean
Inherited from TypedEmitter.emit
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:371

eventNames

eventNames(): (keyof PresenceEventMap<T>)[]
Returns (keyof PresenceEventMap<T>)[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:372

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from TypedEmitter.getMaxListeners
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:376

listenerCount

listenerCount(type): number
Parameters
- type: keyof PresenceEventMap<T>
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:373

listeners

listeners<U>(type): PresenceEventMap<T>[U][]
Type Parameters
- U extends keyof PresenceEventMap<T>
Parameters
- type: U
Returns PresenceEventMap<T>[U][]
Inherited from TypedEmitter.listeners
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:374

off

off<U>(event, listener): this
Type Parameters
- U extends keyof PresenceEventMap<T>
Parameters
- event: U
- listener: PresenceEventMap<T>[U]
Returns this
Inherited from TypedEmitter.off
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:370

on

on<U>(event, listener): this
Type Parameters
- U extends keyof PresenceEventMap<T>
Parameters
- event: U
- listener: PresenceEventMap<T>[U]
Returns this
Inherited from TypedEmitter.on
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:369

once

once<U>(event, listener): this
Type Parameters
- U extends keyof PresenceEventMap<T>
Parameters
- event: U
- listener: PresenceEventMap<T>[U]
Returns this
Inherited from TypedEmitter.once
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:368

prependListener

prependListener<U>(event, listener): this
Type Parameters
- U extends keyof PresenceEventMap<T>
Parameters
- event: U
- listener: PresenceEventMap<T>[U]
Returns this
Inherited from TypedEmitter.prependListener
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:364

prependOnceListener

prependOnceListener<U>(event, listener): this
Type Parameters
- U extends keyof PresenceEventMap<T>
Parameters
- event: U
- listener: PresenceEventMap<T>[U]
Returns this
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:365

rawListeners

rawListeners<U>(type): PresenceEventMap<T>[U][]
Type Parameters
- U extends keyof PresenceEventMap<T>
Parameters
- type: U
Returns PresenceEventMap<T>[U][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:375

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optional event: keyof PresenceEventMap<T>
Returns this
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:367

removeListener

removeListener<U>(event, listener): this
Type Parameters
- U extends keyof PresenceEventMap<T>
Parameters
- event: U
- listener: PresenceEventMap<T>[U]
Returns this
Inherited from TypedEmitter.removeListener
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:366

setMaxListeners

setMaxListeners(n): this
Parameters
- n: number
Returns this
Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:377

subscribe

subscribe(callback?): void
Parameters
- Optional callback: Callback
Returns void
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:258

unsubscribe

unsubscribe(callback?): void
Parameters
- Optional callback: Callback
Returns void
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:259