More documentation

StanfordSpezi · Jun 13, 2024 · f9dd48c · f9dd48c
1 parent 613cc30
commit f9dd48c
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/spezi-invitation-code/index.js b/spezi-invitation-code/index.js
@@ -12,6 +12,18 @@ const {FieldValue} = require("firebase-admin/firestore");
 
 /**
  * Invitation code verifier for Spezi Firebase.
+ * @example
+ * const invitationCodeVerifier = new InvitationCodeVerifier(
+ *   "invitationCodes",
+ *   "users",
+ *   /^[A-Z0-9]{6}$/
+ * );
+ *
+ * exports.checkInvitationCode = onCall(async (request) => {
+ *   const {invitationCode} = request.data;
+ *   await invitationCodeVerifier.enrollUserInStudy(request, invitationCode);
+ *   return {};
+ * });
  */
 class InvitationCodeVerifier {
   /**