Skip to content

Commit

Permalink
Document firstValueFrom not being supported (#11769)
Browse files Browse the repository at this point in the history
  • Loading branch information
coroiu authored Oct 29, 2024
1 parent e39ab59 commit 021efa2
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions libs/common/src/platform/abstractions/sdk/sdk.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ export abstract class SdkService {
* Retrieve a client initialized for a specific user.
* 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.
*
* **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
*/
abstract userClient$(userId: UserId): Observable<BitwardenClient>;
Expand Down

0 comments on commit 021efa2

Please sign in to comment.