Deprecate get. in SingleUserStateProvider

This commit is contained in:
Hinton 2024-04-02 16:51:01 +02:00
parent a201e9cff1
commit 3912d6a6f8
No known key found for this signature in database
GPG Key ID: 5F7295599C5D965C
1 changed files with 2 additions and 2 deletions

View File

@ -9,9 +9,9 @@ import { ActiveUserState, SingleUserState } from "./user-state";
/** A provider for getting an implementation of state scoped to a given key and userId */
export abstract class SingleUserStateProvider {
/**
* Gets a {@link SingleUserState} scoped to the given {@link KeyDefinition} and {@link UserId}
* @deprecated Use {@link SingleUserStateProvider.get} for `UserKeyDefinition` instead
*
* **NOTE** Consider converting your {@link KeyDefinition} to a {@link UserKeyDefinition} for additional features.
* Gets a {@link SingleUserState} scoped to the given {@link KeyDefinition} and {@link UserId}
*
* @param userId - The {@link UserId} for which you want the user state for.
* @param keyDefinition - The {@link KeyDefinition} for which you want the user state for.