convex-backend PR 121: types(getUserIdentity): note about behavior on HTTP Actions (#38180)

Resolves #120

----

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Co-authored-by: Trung Dang <[email protected]>
GitOrigin-RevId: 53e090ea7999c62383e907ff851e7fd5fb2b1226

Author: 2 people

src/server/authentication.ts

@@ -160,7 +160,9 @@ export interface Auth {
    * Get details about the currently authenticated user.
    *
    * @returns A promise that resolves to a {@link UserIdentity} if the Convex
-   * client was configured with a valid ID token and `null` otherwise.
+   * client was configured with a valid ID token, or if not, will:
+   * + returns `null` on Convex queries, mutations, actions.
+   * + `throw` on HTTP Actions.
    */
   getUserIdentity(): Promise<UserIdentity | null>;
 }