Class ProtoBook

fires: ProtoBook#change:protocols

Hierarchy

Book
- ProtoBook

Index

References

Constructors

constructor

Properties

Methods

References

PeerStore

Re-exports PeerStore

PeerStore

Re-exports PeerStore

Constructors

constructor

new ProtoBook(peerStore: PeerStore): ProtoBook

Overrides Book.constructor

The ProtoBook is responsible for keeping the known supported protocols of a peer.

Parameters
- peerStore: PeerStore
Returns ProtoBook

Properties

_ps

data

data: Map<string, any[] | any>

Map known peers to their data.

eventName

eventName: string

eventProperty

eventProperty: string

eventTransformer

eventTransformer: (data: any) => any[]

Type declaration

- (data: any): any[]
- Parameters
  - data: any
  Returns any[]

Methods

Protected _emit

_emit(peerId: PeerId, data?: any): void

Inherited from Book._emit

Emit data.

Parameters
- peerId: PeerId
- Optional data: any
Returns void

Protected _setData

_setData(peerId: PeerId, data: any, __namedParameters?: { emit: undefined | false | true }): void

Inherited from Book._setData

Set data into the datastructure, persistence and emit it using the provided transformers.

Parameters
- peerId: PeerId
  
  peerId of the data to store
- data: any
  
  data to store.
- Optional __namedParameters: { emit: undefined | false | true }
  - emit: undefined | false | true
Returns void

add

add(peerId: PeerId, protocols: string[]): ProtoBook

Adds known protocols of a provided peer. If the peer was not known before, it will be added.

Parameters
- peerId: PeerId
- protocols: string[]
Returns ProtoBook

delete

delete(peerId: PeerId): boolean

Inherited from Book.delete

Deletes the provided peer from the book.

Parameters
- peerId: PeerId
Returns boolean

get

get(peerId: PeerId): any[] | any | undefined

Inherited from Book.get

Get the known data of a provided peer. Returns undefined if there is no available data for the given peer.

Parameters
- peerId: PeerId
Returns any[] | any | undefined

remove

remove(peerId: PeerId, protocols: string[]): ProtoBook

Removes known protocols of a provided peer. If the protocols did not exist before, nothing will be done.

Parameters
- peerId: PeerId
- protocols: string[]
Returns ProtoBook

set

set(peerId: PeerId, data: any[] | any): void

Inherited from Book.set

Set known data of a provided peer.

Parameters
- peerId: PeerId
- data: any[] | any
Returns void