Class Doc<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<DocEventMap<T>>
- Doc

Constructors

constructor

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

Properties

collection

collection: string

connection

connection: Connection

data

data: T

fetch

fetch: Object

id

id: string

paused

paused: boolean

preventCompose

preventCompose: boolean

submitSource

submitSource: boolean

subscribe

subscribe: Object

subscribed

subscribed: boolean

type

type: Type

unsubscribe

unsubscribe: Object

version

version: number

`Static`defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

create

create(data, callback?): void
Parameters
- data: T
- Optionalcallback: Callback
Returns void
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:179
create(data, type?, callback?): void
Parameters
- data: T
- Optionaltype: string
- Optionalcallback: Callback
Returns void
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:180
create(data, type?, options?, callback?): void
Parameters
- data: T
- Optionaltype: string
- Optionaloptions: ShareDBSourceOptions
- Optionalcallback: Callback
Returns void
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:181

del

del(callback?): void
Parameters
- Optionalcallback: Callback
Returns void
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:183
del(options?, callback?): void
Parameters
- Optionaloptions: ShareDBSourceOptions
- Optionalcallback: Callback
Returns void
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:184

destroy

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

emit

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

eventNames

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

flush

flush(): void
Returns void
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:190

getMaxListeners

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

hasPending

hasPending(): boolean
Returns boolean
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:186

hasWritePending

hasWritePending(): boolean
Returns boolean
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:187

ingestSnapshot

ingestSnapshot(snapshot, callback?): void
Parameters
- snapshot: Pick<Snapshot<T>, "v" | "type" | "data">
- Optionalcallback: Callback
Returns void
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:177

listenerCount

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

listeners

listeners<U>(type): DocEventMap<T>[U][]
Type Parameters
- U extends keyof DocEventMap<T>
Parameters
- type: U
Returns DocEventMap<T>[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 keyof DocEventMap<T>
Parameters
- event: U
- listener: DocEventMap<T>[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 keyof DocEventMap<T>
Parameters
- event: U
- listener: DocEventMap<T>[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 keyof DocEventMap<T>
Parameters
- event: U
- listener: DocEventMap<T>[U]
Returns this
Inherited from TypedEmitter.once
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:366

pause

pause(): void
Returns void
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:188

prependListener

prependListener<U>(event, listener): this
Type Parameters
- U extends keyof DocEventMap<T>
Parameters
- event: U
- listener: DocEventMap<T>[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 keyof DocEventMap<T>
Parameters
- event: U
- listener: DocEventMap<T>[U]
Returns this
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:363

rawListeners

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

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optionalevent: keyof DocEventMap<T>
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 keyof DocEventMap<T>
Parameters
- event: U
- listener: DocEventMap<T>[U]
Returns this
Inherited from TypedEmitter.removeListener
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:364

resume

resume(): void
Returns void
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:189

setMaxListeners

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

submitOp

submitOp(data, options?, callback?): void
Parameters
- data: any
- Optionaloptions: ShareDBSourceOptions
- Optionalcallback: Callback
Returns void
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:182

whenNothingPending

whenNothingPending(callback): void
Parameters
- callback: Object
Returns void
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:185