MockQuorumClients Class

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/test-runtime-utils/legacy.

For more information about our API support guarantees, see here.

Signature

export declare class MockQuorumClients implements IQuorumClients, EventEmitter

Implements: IQuorumClients, EventEmitter

Constructors

Constructor	Alerts	Description
(constructor)(members)	Beta	Constructs a new instance of the MockQuorumClients class

Properties

Property	Alerts	Type	Description
disposed	Beta	boolean

Methods

Method	Alerts	Return Type	Description
addListener(event, listener)	Beta	this
addMember(id, client)	Beta	void
dispose()	Beta	void
emit(event, args)	Beta	boolean
eventNames()	Beta	(string | number)[]
getMaxListeners()	Beta	number
getMember(clientId)	Beta	ISequencedClient | undefined
getMembers()	Beta	Map<string, ISequencedClient>
listenerCount(type)	Beta	number
listeners(event)	Beta	ReturnType<EventEmitter["listeners"]>
off(event, listener)	Beta	this
on(event, listener)	Beta	this
once(event, listener)	Beta	this
prependListener(event, listener)	Beta	this
prependOnceListener(event, listener)	Beta	this
rawListeners(event)	Beta	ReturnType<EventEmitter["rawListeners"]>
removeAllListeners(event)	Beta	this
removeListener(event, listener)	Beta	this
removeMember(id)	Beta	void
setMaxListeners(n)	Beta	this

Constructor Details

(constructor)

Constructs a new instance of the MockQuorumClients class

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

constructor(...members: [string, Partial<ISequencedClient>][]);

Parameters

Parameter	Type	Description
members	[string, Partial<ISequencedClient>][]

Property Details

disposed

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

disposed: boolean;

Type: boolean

Method Details

addListener

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

addListener(event: string | number, listener: (...args: any[]) => void): this;

Parameters

Parameter	Type	Description
event	string | number
listener	(...args: any[]) => void

Returns

Return type: this

addMember

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

addMember(id: string, client: Partial<ISequencedClient>): void;

Parameters

Parameter	Type	Description
id	string
client	Partial<ISequencedClient>

dispose

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

dispose(): void;

emit

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

emit(event: string | number, ...args: any[]): boolean;

Parameters

Parameter	Type	Description
event	string | number
args	any[]

Returns

Return type: boolean

eventNames

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

eventNames(): (string | number)[];

Returns

Return type: (string | number)[]

getMaxListeners

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

getMaxListeners(): number;

Returns

Return type: number

getMember

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

getMember(clientId: string): ISequencedClient | undefined;

Parameters

Parameter	Type	Description
clientId	string

Returns

Return type: ISequencedClient | undefined

getMembers

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

getMembers(): Map<string, ISequencedClient>;

Returns

Return type: Map<string, ISequencedClient>

listenerCount

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

listenerCount(type: string | number): number;

Parameters

Parameter	Type	Description
type	string | number

Returns

Return type: number

listeners

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

listeners(event: string | number): ReturnType<EventEmitter["listeners"]>;

Parameters

Parameter	Type	Description
event	string | number

Returns

Return type: ReturnType<EventEmitter["listeners"]>

off

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

off(event: string | number, listener: (...args: any[]) => void): this;

Parameters

Parameter	Type	Description
event	string | number
listener	(...args: any[]) => void

Returns

Return type: this

on

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

on(event: string | number, listener: (...args: any[]) => void): this;

Parameters

Parameter	Type	Description
event	string | number
listener	(...args: any[]) => void

Returns

Return type: this

once

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

once(event: string | number, listener: (...args: any[]) => void): this;

Parameters

Parameter	Type	Description
event	string | number
listener	(...args: any[]) => void

Returns

Return type: this

prependListener

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

prependListener(event: string | number, listener: (...args: any[]) => void): this;

Parameters

Parameter	Type	Description
event	string | number
listener	(...args: any[]) => void

Returns

Return type: this

prependOnceListener

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

prependOnceListener(event: string | number, listener: (...args: any[]) => void): this;

Parameters

Parameter	Type	Description
event	string | number
listener	(...args: any[]) => void

Returns

Return type: this

rawListeners

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

rawListeners(event: string | number): ReturnType<EventEmitter["rawListeners"]>;

Parameters

Parameter	Type	Description
event	string | number

Returns

Return type: ReturnType<EventEmitter["rawListeners"]>

removeAllListeners

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

removeAllListeners(event?: string | number | undefined): this;

Parameters

Parameter	Modifiers	Type	Description
event	optional	string | number | undefined

Returns

Return type: this

removeListener

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

removeListener(event: string | number, listener: (...args: any[]) => void): this;

Parameters

Parameter	Type	Description
event	string | number
listener	(...args: any[]) => void

Returns

Return type: this

removeMember

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

removeMember(id: string): void;

Parameters

Parameter	Type	Description
id	string

setMaxListeners

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

setMaxListeners(n: number): this;

Parameters

Parameter	Type	Description
n	number

Returns

Return type: this