Skip to main content

LatestMapFactory Interface

Factory for creating a LatestMap or LatestMapRaw State object. \

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.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature​

/** @sealed */
export interface LatestMapFactory

Call Signatures​

CallSignature Alerts Description
<T, Keys extends string | number = string | number, RegistrationKey extends string = string>(args: LatestMapArguments<T, Keys>): InternalTypes.ManagerFactory<RegistrationKey, InternalTypes.MapValueState<T, Keys>, LatestMap<T, Keys>> Beta Factory for creating a LatestMap State object.
<T, Keys extends string | number = string | number, RegistrationKey extends string = string>(args?: LatestMapArgumentsRaw<T, Keys>): InternalTypes.ManagerFactory<RegistrationKey, InternalTypes.MapValueState<T, Keys>, LatestMapRaw<T, Keys>> Beta Factory for creating a LatestMapRaw State object.

Call Signature Details​

<T, Keys extends string | number = string | number, RegistrationKey extends string = string>(args: LatestMapArguments<T, Keys>): InternalTypes.ManagerFactory<RegistrationKey, InternalTypes.MapValueState<T, Keys>, LatestMap<T, Keys>>​

Factory for creating a LatestMap State object.

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

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

Signature​
<T, Keys extends string | number = string | number, RegistrationKey extends string = string>(args: LatestMapArguments<T, Keys>): InternalTypes.ManagerFactory<RegistrationKey, InternalTypes.MapValueState<T, Keys>, LatestMap<T, Keys>>;
Type Parameters​
Parameter Constraint Default Description
T
Keys string | number string | number
RegistrationKey string string
Remarks​

This overload is used when called with LatestMapArguments. That is, if a validator function is provided.

<T, Keys extends string | number = string | number, RegistrationKey extends string = string>(args?: LatestMapArgumentsRaw<T, Keys>): InternalTypes.ManagerFactory<RegistrationKey, InternalTypes.MapValueState<T, Keys>, LatestMapRaw<T, Keys>>​

Factory for creating a LatestMapRaw State object.

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

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

Signature​
<T, Keys extends string | number = string | number, RegistrationKey extends string = string>(args?: LatestMapArgumentsRaw<T, Keys>): InternalTypes.ManagerFactory<RegistrationKey, InternalTypes.MapValueState<T, Keys>, LatestMapRaw<T, Keys>>;
Type Parameters​
Parameter Constraint Default Description
T
Keys string | number string | number
RegistrationKey string string
Remarks​

This overload is used when called with LatestMapArgumentsRaw. That is, if a validator function is _not_ provided.