From c9c6b7a21fa7bddfd8e0a1daad4fd622aecab4f8 Mon Sep 17 00:00:00 2001
From: Justin Baur <19896123+justindbaur@users.noreply.github.com>
Date: Tue, 28 May 2024 09:22:03 -0400
Subject: [PATCH] Add `@throws` Docs

---
 libs/common/src/platform/abstractions/crypto.service.ts | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/libs/common/src/platform/abstractions/crypto.service.ts b/libs/common/src/platform/abstractions/crypto.service.ts
index 9be4b95e079..c2ecec6a098 100644
--- a/libs/common/src/platform/abstractions/crypto.service.ts
+++ b/libs/common/src/platform/abstractions/crypto.service.ts
@@ -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
    * 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.
+   *
+   * @throws If an invalid user id is passed in.
    */
   abstract cipherDecryptionKeys$(
     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.
    * @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.
+   *
+   * @throws If an invalid user id is passed in.
    */
   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.
    *
    * @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>;
 }