Interface LocalPeersEvents

interface LocalPeersEvents {
    discovery-key: ((discoveryKey: Buffer, protomux: Protomux<NoiseSecretStream<Duplex<any, any, any, any, true, true, DuplexEvents<any, any>>>>) => void);
    failed-to-handle-message: ((messageType: string, errorMessage?: string) => void);
    got-project-details: ((peerId: string, details: ProjectJoinDetails) => void);
    got-project-details-ack: ((peerId: string, details: ProjectJoinDetailsAck) => void);
    invite: ((peerId: string, invite: Invite) => void);
    invite-ack: ((peerId: string, invite: InviteAck) => void);
    invite-cancel: ((peerId: string, invite: InviteCancel) => void);
    invite-cancel-ack: ((peerId: string, invite: InviteCancelAck) => void);
    invite-response: ((peerId: string, inviteResponse: InviteResponse) => void);
    invite-response-ack: ((peerId: string, inviteResponse: InviteResponseAck) => void);
    peer-add: ((peer: PeerInfoConnected) => void);
    peers: ((peers: PeerInfo[]) => void);
}

Properties

discovery-key failed-to-handle-message got-project-details got-project-details-ack invite invite-ack invite-cancel invite-cancel-ack invite-response invite-response-ack peer-add peers

Properties

discovery-key

discovery-key: ((discoveryKey: Buffer, protomux: Protomux<NoiseSecretStream<Duplex<any, any, any, any, true, true, DuplexEvents<any, any>>>>) => void)

Emitted when a new hypercore is replicated (by a peer) to a peer protomux instance (passed as the second parameter)

failed-to-handle-message

failed-to-handle-message: ((messageType: string, errorMessage?: string) => void)

Emitted when we received a message we couldn't handle for some reason. Primarily useful for testing

got-project-details

got-project-details: ((peerId: string, details: ProjectJoinDetails) => void)

Emitted when project details are received

got-project-details-ack

got-project-details-ack: ((peerId: string, details: ProjectJoinDetailsAck) => void)

Emitted when project details are acknowledged as received

invite

invite: ((peerId: string, invite: Invite) => void)

Emitted when an invite is received

invite-ack

invite-ack: ((peerId: string, invite: InviteAck) => void)

Emitted when an invite acknowledgement is received

invite-cancel

invite-cancel: ((peerId: string, invite: InviteCancel) => void)

Emitted when we receive a cancelation for an invite

invite-cancel-ack

invite-cancel-ack: ((peerId: string, invite: InviteCancelAck) => void)

Emitted when we receive a cancelation acknowledgement for an invite

invite-response

invite-response: ((peerId: string, inviteResponse: InviteResponse) => void)

Emitted when an invite response is received

invite-response-ack

invite-response-ack: ((peerId: string, inviteResponse: InviteResponseAck) => void)

Emitted when an invite response acknowledgement is received

peer-add

peer-add: ((peer: PeerInfoConnected) => void)

Emitted when a new peer is connected

peers

peers: ((peers: PeerInfo[]) => void)

Emitted whenever the connection status of peers changes. An array of peerInfo objects with a peer id and the peer connection status

Settings

Member Visibility

On This Page

Properties