IQuorumClients Interface

Packages > @fluidframework/driver-definitions > IQuorumClients

Interface for tracking clients in the Quorum.

Signature

export interface IQuorumClients

Properties

Property Type Description
off IQuorumClients["on"]
once IQuorumClients["on"]

Methods

Method Return Type Description
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

Parameter Type Description
clientId string

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

Parameter Type Description
event "addMember"
listener (clientId: string, details: ISequencedClient) => void

Returns

Return type: any

on

Signature

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

Parameters

Parameter Type Description
event "removeMember"
listener (clientId: string) => void

Returns

Return type: any

on

Signature

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

Parameters

Parameter Type Description
event "error"
listener (message: any) => void

Returns

Return type: any