Skip to main content
Version: v2

IQuorumClients Interface

Interface for tracking clients in the Quorum.

Signature​

export interface IQuorumClients

Properties​

PropertyTypeDescription
offIQuorumClients["on"]
onceIQuorumClients["on"]

Methods​

MethodReturn TypeDescription
getMember(clientId)ISequencedClient | undefined
getMembers()Map<string, ISequencedClient>
on(event, listener)any
on(event, listener)any
on(event, listener)any

Property Details​

off​

Signature​

off: IQuorumClients["on"];

Type: IQuorumClients["on"]

once​

Signature​

once: IQuorumClients["on"];

Type: IQuorumClients["on"]

Method Details​

getMember​

Signature​

getMember(clientId: string): ISequencedClient | undefined;

Parameters​

ParameterTypeDescription
clientIdstring

Returns​

Return type: ISequencedClient | undefined

getMembers​

Signature​

getMembers(): Map<string, ISequencedClient>;

Returns​

Return type: Map<string, ISequencedClient>

on​

Signature​

on(event: "addMember", listener: (clientId: string, details: ISequencedClient) => void): any;

Parameters​

ParameterTypeDescription
event"addMember"
listener(clientId: string, details: ISequencedClient) => void

Returns​

Return type: any

on​

Signature​

on(event: "removeMember", listener: (clientId: string) => void): any;

Parameters​

ParameterTypeDescription
event"removeMember"
listener(clientId: string) => void

Returns​

Return type: any

on​

Signature​

on(event: "error", listener: (message: any) => void): any;

Parameters​

ParameterTypeDescription
event"error"
listener(message: any) => void

Returns​

Return type: any