Skip to main content

MockDeltaManager Class

Mock implementation of IDeltaManager for testing that creates mock DeltaQueues for testing

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 MockDeltaManager extends TypedEventEmitter<IDeltaManagerEvents> implements IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>

Extends: TypedEventEmitter<IDeltaManagerEvents>

Implements: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>

Constructors​

Constructor Alerts Description
(constructor)(getClientId) Alpha Constructs a new instance of the MockDeltaManager class

Properties​

Property Alerts Modifiers Type Description
active Alpha readonly boolean
clientDetails Alpha readonly IClientDetails
clientSequenceNumber Alpha number
clientType Alpha readonly string
disposed Alpha readonly any
hasCheckpointSequenceNumber Alpha boolean
IDeltaSender Alpha readonly this
inbound Alpha readonly MockDeltaQueue<ISequencedDocumentMessage>
inboundSignal Alpha readonly MockDeltaQueue<ISignalMessage>
initialSequenceNumber Alpha number
lastKnownSeqNumber Alpha readonly
lastMessage Alpha ISequencedDocumentMessage | undefined
lastSequenceNumber Alpha number
maxMessageSize Alpha readonly number
minimumSequenceNumber Alpha number
outbound Alpha readonly MockDeltaQueue<IDocumentMessage[]>
readOnlyInfo Alpha ReadOnlyInfo
serviceConfiguration Alpha readonly IClientConfiguration
version Alpha readonly string

Constructor Details​

(constructor)​

Constructs a new instance of the MockDeltaManager 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(getClientId?: (() => string) | undefined);

Parameters​

Parameter Modifiers Type Description
getClientId optional (() => string) | undefined

Property Details​

active​

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​

readonly active: boolean;

Type: boolean

clientDetails​

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​

readonly clientDetails: IClientDetails;

Type: IClientDetails

clientSequenceNumber​

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​

clientSequenceNumber: number;

Type: number

clientType​

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​

readonly clientType: string;

Type: string

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​

get disposed(): any;

Type: any

hasCheckpointSequenceNumber​

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​

hasCheckpointSequenceNumber: boolean;

Type: boolean

IDeltaSender​

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​

get IDeltaSender(): this;

Type: this

inbound​

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​

get inbound(): MockDeltaQueue<ISequencedDocumentMessage>;

Type: MockDeltaQueue<ISequencedDocumentMessage>

inboundSignal​

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​

get inboundSignal(): MockDeltaQueue<ISignalMessage>;

Type: MockDeltaQueue<ISignalMessage>

initialSequenceNumber​

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​

initialSequenceNumber: number;

Type: number

lastKnownSeqNumber​

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​

readonly lastKnownSeqNumber = 0;

lastMessage​

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​

lastMessage: ISequencedDocumentMessage | undefined;

Type: ISequencedDocumentMessage | undefined

lastSequenceNumber​

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​

lastSequenceNumber: number;

Type: number

maxMessageSize​

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​

readonly maxMessageSize: number;

Type: number

minimumSequenceNumber​

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​

minimumSequenceNumber: number;

Type: number

outbound​

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​

get outbound(): MockDeltaQueue<IDocumentMessage[]>;

Type: MockDeltaQueue<IDocumentMessage[]>

readOnlyInfo​

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​

readOnlyInfo: ReadOnlyInfo;

Type: ReadOnlyInfo

serviceConfiguration​

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​

get serviceConfiguration(): IClientConfiguration;

Type: IClientConfiguration

version​

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​

get version(): string;

Type: string