Class MilestoneDB`Abstract`

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

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

Hierarchy (view full)

TypedEmitter<MilestoneDBEventMap>
- MilestoneDB

Constructors

constructor

new MilestoneDB(): MilestoneDB
Returns MilestoneDB
Inherited from TypedEmitter.constructor

Properties

`Static` defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

close

close(callback?): void
Parameters
- Optional callback: BasicCallback
Returns void
- Defined in node_modules/@types/sharedb/index.d.ts:230

emit

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

eventNames

eventNames(): (keyof MilestoneDBEventMap)[]
Returns (keyof MilestoneDBEventMap)[]
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

getMilestoneSnapshot

getMilestoneSnapshot(collection, id, version, callback?): void
Parameters
- collection: string
- id: string
- version: number
- Optional callback: BasicCallback
Returns void
- Defined in node_modules/@types/sharedb/index.d.ts:231

getMilestoneSnapshotAtOrAfterTime

getMilestoneSnapshotAtOrAfterTime(collection, id, timestamp, callback?): void
Parameters
- collection: string
- id: string
- timestamp: number
- Optional callback: BasicCallback
Returns void
- Defined in node_modules/@types/sharedb/index.d.ts:239

getMilestoneSnapshotAtOrBeforeTime

getMilestoneSnapshotAtOrBeforeTime(collection, id, timestamp, callback?): void
Parameters
- collection: string
- id: string
- timestamp: number
- Optional callback: BasicCallback
Returns void
- Defined in node_modules/@types/sharedb/index.d.ts:233

listenerCount

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

listeners

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

rawListeners

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

removeAllListeners

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

saveMilestoneSnapshot

saveMilestoneSnapshot(collection, snapshot, callback?): void
Parameters
- collection: string
- snapshot: sharedb.Snapshot
- Optional callback: BasicCallback
Returns void
- Defined in node_modules/@types/sharedb/index.d.ts:232

setMaxListeners

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