From 2980d2313be7660e81b195d433a8fe13bedbeadd Mon Sep 17 00:00:00 2001 From: Matthew Miller Date: Fri, 4 Mar 2022 22:34:26 -0800 Subject: Add some docs --- packages/browser/src/helpers/identifyRegistrationError.ts | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'packages/browser/src/helpers/identifyRegistrationError.ts') diff --git a/packages/browser/src/helpers/identifyRegistrationError.ts b/packages/browser/src/helpers/identifyRegistrationError.ts index 8da0c97..75d6740 100644 --- a/packages/browser/src/helpers/identifyRegistrationError.ts +++ b/packages/browser/src/helpers/identifyRegistrationError.ts @@ -1,6 +1,10 @@ import { isValidDomain } from './isValidDomain'; import { WebAuthnError } from './structs'; + +/** + * Attempt to intuit _why_ an error was raised after calling `navigator.credentials.create()` + */ export function identifyRegistrationError({ error, options }: { error: Error, options: CredentialCreationOptions, -- cgit v1.2.3