SharedObjectKey TypeAlias

A RegistryKey for a SharedObjectKind.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/shared-object-base/alpha.

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 type SharedObjectKey<T> = RegistryKey<SharedObjectKindAlpha<T>, SharedObjectKindAlpha>;

Type Parameters

Parameter	Description
T

Remarks

This is implemented by SharedObjectKind, but alternative implementations can be used if needed.

If you want lazy loading and need a key that does not eagerly load the SharedObjectKind, an alternative SharedObjectKey can be implemented.