bitwarden/browser
1
0
Fork 0
mirror of https://github.com/bitwarden/browser synced 2025-12-16 08:13:42 +00:00
Code Issues Releases Wiki Activity

Add @throws Docs

Browse Source
This commit is contained in:
Justin Baur
2024-05-28 09:22:03 -04:00
parent cacd892f6a
commit c9c6b7a21f
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
libs/common/src/platform/abstractions/crypto.service.ts
View File

@@ -382,6 +382,8 @@ export abstract class CryptoService {
* @param legacySupport `true` if you need to support retrieving the legacy version of the users key, `false` if * @param legacySupport `true` if you need to support retrieving the legacy version of the users key, `false` if
* you do not need legacy support. Use `true` by necessity only. Defaults to `false`. Legacy support is for users * you do not need legacy support. Use `true` by necessity only. Defaults to `false`. Legacy support is for users
* that may not have updated to use the new {@link UserKey} yet. * that may not have updated to use the new {@link UserKey} yet.
*
* @throws If an invalid user id is passed in.
*/ */
abstract cipherDecryptionKeys$( abstract cipherDecryptionKeys$(
userId: UserId, userId: UserId,
@@ -393,6 +395,8 @@ export abstract class CryptoService {
* @param userId The user id of the user of which to get the keys for. * @param userId The user id of the user of which to get the keys for.
* @return An observable stream of the users organization keys if they are unlocked, or null if the user is not unlocked. * @return An observable stream of the users organization keys if they are unlocked, or null if the user is not unlocked.
* The observable will stay alive through locks/unlocks. * The observable will stay alive through locks/unlocks.
*
* @throws If an invalid user id is passed in.
*/ */
abstract orgKeys$(userId: UserId): Observable<Record<OrganizationId, OrgKey> | null>; abstract orgKeys$(userId: UserId): Observable<Record<OrganizationId, OrgKey> | null>;
@@ -401,6 +405,8 @@ export abstract class CryptoService {
* a {@link UserKey} or {@link UserPrivateKey} that is decryptable, this will emit null. * a {@link UserKey} or {@link UserPrivateKey} that is decryptable, this will emit null.
* *
* @param userId The user id of the user of which to get the public key for. * @param userId The user id of the user of which to get the public key for.
*
* @throws If an invalid user id is passed in.
*/ */
abstract userPublicKey$(userId: UserId): Observable<UserPublicKey>; abstract userPublicKey$(userId: UserId): Observable<UserPublicKey>;
} }