Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @simplewebauthn/browser

Index

Functions

  • browserSupportsWebAuthn(): boolean
  • Determine if the browser is capable of Webauthn

    Returns boolean

  • browserSupportsWebAuthnAutofill(): Promise<boolean>
  • Determine if the browser supports conditional UI, so that WebAuthn credentials can be shown to the user in the browser's typical password autofill popup.

    Returns Promise<boolean>

  • platformAuthenticatorIsAvailable(): Promise<boolean>
  • Determine whether the browser can communicate with a built-in authenticator, like Touch ID, Android fingerprint scanner, or Windows Hello.

    This method will not be able to tell you the name of the platform authenticator.

    Returns Promise<boolean>

  • Begin authenticator "login" via WebAuthn assertion

    Parameters

    • requestOptionsJSON: PublicKeyCredentialRequestOptionsJSON

      Output from @simplewebauthn/server's generateAssertionOptions(...)

    • useBrowserAutofill: boolean = false

      Initialize conditional UI to enable logging in via browser autofill prompts

    Returns Promise<AuthenticationCredentialJSON>

Generated using TypeDoc