DataStoreKey TypeAlias
A RegistryKey for a DataStoreKind.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/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 DataStoreKey<T, TAll = unknown> = RegistryKey<Promise<DataStoreKind<T>>, Promise<DataStoreKind<TAll>>>;
Type Parameters
| Parameter | Default | Description |
|---|---|---|
| T | The type to expose from the DataStoreKind this key resolves to. | |
| TAll | unknown | The type covering all DataStoreKinds in the Registry this key is used with. |
Remarks
This is implemented by DataStoreKind, but alternative implementations can be used if needed.
If you want lazy loading and need a key that does not eagerly load the DataStoreKind, an alternative DataStoreKey can be implemented.