Class LocalPresence<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<LocalPresenceEventMap>
- LocalPresence

Constructors

constructor

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

Properties

connection

connection: string

presence

presence: Presence<T>

presenceId

presenceId: string

presenceVersion

presenceVersion: number

value

value: T

`Static`defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

destroy

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

emit

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

eventNames

eventNames(): "error"[]
Returns "error"[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:370

getMaxListeners

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

listenerCount

listenerCount(type): number
Parameters
- type: "error"
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:371

listeners

listeners<U>(type): LocalPresenceEventMap[U][]
Type Parameters
- U extends "error"
Parameters
- type: U
Returns LocalPresenceEventMap[U][]
Inherited from TypedEmitter.listeners
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:372

off

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

on

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

once

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

prependListener

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

prependOnceListener

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

rawListeners

rawListeners<U>(type): LocalPresenceEventMap[U][]
Type Parameters
- U extends "error"
Parameters
- type: U
Returns LocalPresenceEventMap[U][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:373

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optionalevent: "error"
Returns this
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:365

removeListener

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

send

send(callback?): void
Parameters
- Optionalcallback: Callback
Returns void
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:274

setMaxListeners

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

submit

submit(value, callback?): void
Parameters
- value: T
- Optionalcallback: Callback
Returns void
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:273