1
0
mirror of https://github.com/bitwarden/browser.git synced 2024-11-07 09:31:31 +01:00

Document firstValueFrom not being supported (#11769)

This commit is contained in:
Andreas Coroiu 2024-10-29 16:00:02 +01:00 committed by GitHub
parent e39ab59fa8
commit 021efa2c90
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -20,6 +20,11 @@ export abstract class SdkService {
* Retrieve a client initialized for a specific user. * Retrieve a client initialized for a specific user.
* This client can be used for operations that require a user context, such as retrieving ciphers * This client can be used for operations that require a user context, such as retrieving ciphers
* and operations involving crypto. It can also be used for operations that don't require a user context. * and operations involving crypto. It can also be used for operations that don't require a user context.
*
* **WARNING:** Do not use `firstValueFrom(userClient$)`! Any operations on the client must be done within the observable.
* The client will be destroyed when the observable is no longer subscribed to.
* Please let platform know if you need a client that is not destroyed when the observable is no longer subscribed to.
*
* @param userId * @param userId
*/ */
abstract userClient$(userId: UserId): Observable<BitwardenClient>; abstract userClient$(userId: UserId): Observable<BitwardenClient>;