Class Connection

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<ConnectionEventMap>
- Connection

Constructors

constructor

new Connection(ws): Connection
Parameters
- ws: Socket
Returns Connection
Overrides TypedEmitter.constructor
- Defined in node_modules/@types/sharedb/lib/client/index.d.ts:6

Properties

agent

agent: Agent<any>

`Readonly`canSend

canSend: boolean

collections

collections: Record<string, Record<string, Doc<any>>>

debug

debug: boolean

id

id: string

nextQueryId

nextQueryId: number

nextSnapshotRequestId

nextSnapshotRequestId: number

queries

queries: Record<string, Query<any>>

seq

seq: number

state

state: string

`Static`defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener<U>(event, listener): this
Type Parameters
- U extends
      | "error"
      | ConnectionState
      | "receive"
      | "doc"
      | "send"
      | "connection error"
      | "pong"
      | "state"
Parameters
- event: U
- listener: ConnectionEventMap[U]
Returns this
Inherited from TypedEmitter.addListener
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:361

close

close(): void
Returns void
- Defined in node_modules/@types/sharedb/lib/client/index.d.ts:25

createFetchQuery

createFetchQuery<T>(collectionName, query, options?, callback?): Query<T>
Type Parameters
- T = any
Parameters
- collectionName: string
- query: any
- Optionaloptions: Object
- Optionalcallback: Object
Returns Query<T>
- Defined in node_modules/@types/sharedb/lib/client/index.d.ts:27

createSubscribeQuery

createSubscribeQuery<T>(collectionName, query, options?, callback?): Query<T>
Type Parameters
- T = any
Parameters
- collectionName: string
- query: any
- Optionaloptions: Object
- Optionalcallback: Object
Returns Query<T>
- Defined in node_modules/@types/sharedb/lib/client/index.d.ts:33

emit

emit<U>(event, ...args): boolean
Type Parameters
- U extends
      | "error"
      | ConnectionState
      | "receive"
      | "doc"
      | "send"
      | "connection error"
      | "pong"
      | "state"
Parameters
- event: U
- Rest...args: Parameters<ConnectionEventMap[U]>
Returns boolean
Inherited from TypedEmitter.emit
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:369

eventNames

eventNames(): (
    | "error"
    | ConnectionState
    | "receive"
    | "doc"
    | "send"
    | "connection error"
    | "pong"
    | "state")[]
Returns (
    | "error"
    | ConnectionState
    | "receive"
    | "doc"
    | "send"
    | "connection error"
    | "pong"
    | "state")[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:370

fetchSnapshot

fetchSnapshot(collection, id, version, callback): void
Parameters
- collection: string
- id: string
- version: number
- callback: Object
Returns void
- Defined in node_modules/@types/sharedb/lib/client/index.d.ts:39

fetchSnapshotByTimestamp

fetchSnapshotByTimestamp(collection, id, timestamp, callback): void
Parameters
- collection: string
- id: string
- timestamp: number
- callback: Object
Returns void
- Defined in node_modules/@types/sharedb/lib/client/index.d.ts:45

get

get(collectionName, documentID): Doc<any>
Parameters
- collectionName: string
- documentID: string
Returns Doc<any>
- Defined in node_modules/@types/sharedb/lib/client/index.d.ts:26

getDocPresence

getDocPresence(collection, id): Presence<any>
Parameters
- collection: string
- id: string
Returns Presence<any>
- Defined in node_modules/@types/sharedb/lib/client/index.d.ts:52

getMaxListeners

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

getPresence

getPresence(channel): Presence<any>
Parameters
- channel: string
Returns Presence<any>
- Defined in node_modules/@types/sharedb/lib/client/index.d.ts:51

hasPending

hasPending(): boolean
Returns whether anything in this client is either:
- In-flight, waiting on a response from the server
- Pending (locally queued)
Returns boolean
- Defined in node_modules/@types/sharedb/lib/client/index.d.ts:59

listenerCount

listenerCount(type): number
Parameters
- type:
      | "error"
      | ConnectionState
      | "receive"
      | "doc"
      | "send"
      | "connection error"
      | "pong"
      | "state"
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:371

listeners

listeners<U>(type): ConnectionEventMap[U][]
Type Parameters
- U extends
      | "error"
      | ConnectionState
      | "receive"
      | "doc"
      | "send"
      | "connection error"
      | "pong"
      | "state"
Parameters
- type: U
Returns ConnectionEventMap[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"
      | ConnectionState
      | "receive"
      | "doc"
      | "send"
      | "connection error"
      | "pong"
      | "state"
Parameters
- event: U
- listener: ConnectionEventMap[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"
      | ConnectionState
      | "receive"
      | "doc"
      | "send"
      | "connection error"
      | "pong"
      | "state"
Parameters
- event: U
- listener: ConnectionEventMap[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"
      | ConnectionState
      | "receive"
      | "doc"
      | "send"
      | "connection error"
      | "pong"
      | "state"
Parameters
- event: U
- listener: ConnectionEventMap[U]
Returns this
Inherited from TypedEmitter.once
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:366

ping

ping(): void
Returns void
- Defined in node_modules/@types/sharedb/lib/client/index.d.ts:78

prependListener

prependListener<U>(event, listener): this
Type Parameters
- U extends
      | "error"
      | ConnectionState
      | "receive"
      | "doc"
      | "send"
      | "connection error"
      | "pong"
      | "state"
Parameters
- event: U
- listener: ConnectionEventMap[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"
      | ConnectionState
      | "receive"
      | "doc"
      | "send"
      | "connection error"
      | "pong"
      | "state"
Parameters
- event: U
- listener: ConnectionEventMap[U]
Returns this
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:363

rawListeners

rawListeners<U>(type): ConnectionEventMap[U][]
Type Parameters
- U extends
      | "error"
      | ConnectionState
      | "receive"
      | "doc"
      | "send"
      | "connection error"
      | "pong"
      | "state"
Parameters
- type: U
Returns ConnectionEventMap[U][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:373

removeAllListeners

removeAllListeners(event?): this
Parameters
- Optionalevent:
      | "error"
      | ConnectionState
      | "receive"
      | "doc"
      | "send"
      | "connection error"
      | "pong"
      | "state"
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"
      | ConnectionState
      | "receive"
      | "doc"
      | "send"
      | "connection error"
      | "pong"
      | "state"
Parameters
- event: U
- listener: ConnectionEventMap[U]
Returns this
Inherited from TypedEmitter.removeListener
- Defined in node_modules/@types/sharedb/lib/sharedb.d.ts:364

send

send(message): void
Manually send a JSON-serializable message to the server.

WARNING - This is mostly for internal use within sharedb.

Prefer to use methods like Doc#submitOp, Doc#subscribe, Connection#createFetchQuery, etc., which will manage the necessary message exchanges.
Parameters
- message: Record<string, unknown>
Returns void
- Defined in node_modules/@types/sharedb/lib/client/index.d.ts:76

setMaxListeners

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

whenNothingPending

whenNothingPending(callback): void
Invokes the callback once nothing on this client is in-flight or pending.
Parameters
- callback: Object
Returns void
See
hasPending
- Defined in node_modules/@types/sharedb/lib/client/index.d.ts:66