Interface IPeer<IEventsList>

Type parameters

IEventsList: IPeerEventsList

Hierarchy

INode<IEventsList>
- IPeer
  - Peer

Indexable

[key: string]: any

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IPeer(id?: string): any

Inherited from INode.__new
- Defined in ancient-channels/node_modules/ancient-mixins/lib/node.d.ts:11
Parameters
- Optional id: string
Returns any

Properties

channelsManager

channelsManager: TChannelsManager

cursorsManager

cursorsManager: TCursorManager

emitter

emitter: EventEmitter

id

id: string

isDestroyed

isDestroyed: boolean

prepared

prepared: IPeerPrepared

relations

relations: IPeerRelationsChannels

Methods

channelDestroyed

channelDestroyed(channelId: string): void

- Defined in ancient-peer/src/lib/peer.ts:118
Parameters
- channelId: string
Returns void

cursorDestroyed

cursorDestroyed(channelId: string, cursorId: string): void

- Defined in ancient-peer/src/lib/peer.ts:117
Parameters
- channelId: string
- cursorId: string
Returns void

destroy

destroy(): void

Inherited from INode.destroy

Overrides IEvents.destroy
- Defined in ancient-channels/node_modules/ancient-mixins/lib/node.d.ts:15
Returns void

emit

emit<IE>(eventName: IE, data: IEventsList[IE]): this

Inherited from IEvents.emit
- Defined in ancient-channels/node_modules/ancient-mixins/lib/events.d.ts:6
Type parameters
- IE: keyof IEventsList
Parameters
- eventName: IE
- data: IEventsList[IE]
Returns this

generateId

generateId(): string

Inherited from INode.generateId
- Defined in ancient-channels/node_modules/ancient-mixins/lib/node.d.ts:13
Returns string

getApiCallbacks

getApiCallbacks(apiQuery: any): Promise<IPeerApiCallbacks>

- Defined in ancient-peer/src/lib/peer.ts:110
Parameters
- apiQuery: any
Returns Promise<IPeerApiCallbacks>

gotPkg

gotPkg(channelId: string, pkg: IPkg): void

- Defined in ancient-peer/src/lib/peer.ts:116
Parameters
- channelId: string
- pkg: IPkg
Returns void

handleBundles

handleBundles(channelId: string, pkg: IPkg): void

- Defined in ancient-peer/src/lib/peer.ts:121
Parameters
- channelId: string
- pkg: IPkg
Returns void

handleDestroyed

handleDestroyed(channelId: string, pkg: IPkg): void

- Defined in ancient-peer/src/lib/peer.ts:122
Parameters
- channelId: string
- pkg: IPkg
Returns void

handleQueries

handleQueries(channelId: string, pkg: IPkg): void

- Defined in ancient-peer/src/lib/peer.ts:119
Parameters
- channelId: string
- pkg: IPkg
Returns void

handleQuery

handleQuery(channelId: string, query: any): void

- Defined in ancient-peer/src/lib/peer.ts:120
Parameters
- channelId: string
- query: any
Returns void

off

off<IE>(eventName: IE, listener: function): this

Inherited from IEvents.off
- Defined in ancient-channels/node_modules/ancient-mixins/lib/events.d.ts:9
Type parameters
- IE: keyof IEventsList
Parameters
- eventName: IE
- listener: function
  - - (data: IEventsList[IE]): void
    - Parameters
      - data: IEventsList[IE]
      Returns void
Returns this

on

on<IE>(eventName: IE, listener: function): this

Inherited from IEvents.on
- Defined in ancient-channels/node_modules/ancient-mixins/lib/events.d.ts:7
Type parameters
- IE: keyof IEventsList
Parameters
- eventName: IE
- listener: function
  - - (data: IEventsList[IE]): void
    - Parameters
      - data: IEventsList[IE]
      Returns void
Returns this

once

once<IE>(eventName: IE, listener: function): this

Inherited from IEvents.once
- Defined in ancient-channels/node_modules/ancient-mixins/lib/events.d.ts:8
Type parameters
- IE: keyof IEventsList
Parameters
- eventName: IE
- listener: function
  - - (data: IEventsList[IE]): void
    - Parameters
      - data: IEventsList[IE]
      Returns void
Returns this

ready

ready(channelId: string): void

- Defined in ancient-peer/src/lib/peer.ts:114
Parameters
- channelId: string
Returns void

sendDestroyed

sendDestroyed(cursor: TPeerCursor): void

- Defined in ancient-peer/src/lib/peer.ts:115
Parameters
- cursor: TPeerCursor
Returns void

sendQuery

sendQuery(cursor: TPeerCursor): void

- Defined in ancient-peer/src/lib/peer.ts:113
Parameters
- cursor: TPeerCursor
Returns void

wrap

wrap(): void

- Defined in ancient-peer/src/lib/peer.ts:112
Returns void

Generated using TypeDoc