1 files changed, 9 insertions, 5 deletions
diff --git a/packages/browser/src/helpers/webAuthnAbortService.ts b/packages/browser/src/helpers/webAuthnAbortService.ts
index ed007e2..ce6979c 100644
--- a/packages/browser/src/helpers/webAuthnAbortService.ts
+++ b/packages/browser/src/helpers/webAuthnAbortService.ts
@@ -1,13 +1,10 @@
-/**
- * A way to cancel an existing WebAuthn request, for example to cancel a
- * WebAuthn autofill authentication request for a manual authentication attempt.
- */
 class BaseWebAuthnAbortService {
   private controller: AbortController | undefined;
 
   /**
    * Prepare an abort signal that will help support multiple auth attempts without needing to
-   * reload the page
+   * reload the page. This is automatically called whenever `startRegistration()` and
+   * `startAuthentication()` are called.
    */
   createNewAbortSignal() {
     // Abort any existing calls to navigator.credentials.create() or navigator.credentials.get()
@@ -26,4 +23,11 @@ class BaseWebAuthnAbortService {
   }
 }
 
+/**
+ * A service singleton to help ensure that only a single WebAuthn ceremony is active at a time.
+ *
+ * Users of **@simplewebauthn/browser** shouldn't typically need to use this, but it can help e.g.
+ * developers building projects that use client-side routing to better control the behavior of
+ * their UX in response to router navigation events.
+ */
 export const WebauthnAbortService = new BaseWebAuthnAbortService();