Skip to main content

LatestMapArguments Interface

Arguments that are passed to the StateFactory.latestMap function. \

This API is provided as a beta preview and may change without notice.

To use, import via @fluidframework/presence/beta.

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

Input

This type is "input," meaning that code outside of the library defining it should not read from it. Future versions of this type may add optional members or make typing of members more general.

Signature

export interface LatestMapArguments<T, Keys extends string | number = string | number> extends LatestMapArgumentsRaw<T, Keys>

Extends: LatestMapArgumentsRaw<T, Keys>

Type Parameters

Parameter Constraint Default Description
T
Keys string | number string | number

Properties

Property Alerts Type Description
validator Beta StateSchemaValidator<T> An optional function that will be called at runtime to validate the presence data. A runtime validator is strongly recommended. See StateSchemaValidator.

Property Details

validator

An optional function that will be called at runtime to validate the presence data. A runtime validator is strongly recommended. See StateSchemaValidator.

This API is provided as a beta preview and may change without notice.

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

Signature
validator: StateSchemaValidator<T>;

Type: StateSchemaValidator<T>