Module @simplewebauthn/browser

Index

Functions

Functions

browserSupportsWebauthn

browserSupportsWebauthn(): boolean

- Defined in browser/src/helpers/browserSupportsWebauthn.ts:4
Determine if the browser is capable of Webauthn

Returns boolean

platformAuthenticatorIsAvailable

platformAuthenticatorIsAvailable(): Promise<boolean>

- Defined in browser/src/helpers/platformAuthenticatorIsAvailable.ts:9
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>

startAuthentication

startAuthentication(requestOptionsJSON: PublicKeyCredentialRequestOptionsJSON): Promise<AuthenticationCredentialJSON>

- Defined in browser/src/methods/startAuthentication.ts:19
Begin authenticator "login" via WebAuthn assertion

Parameters
- requestOptionsJSON: PublicKeyCredentialRequestOptionsJSON
  
  Output from @simplewebauthn/server's generateAssertionOptions(...)
Returns Promise<AuthenticationCredentialJSON>

startRegistration

startRegistration(creationOptionsJSON: PublicKeyCredentialCreationOptionsJSON): Promise<RegistrationCredentialJSON>

- Defined in browser/src/methods/startRegistration.ts:19
Begin authenticator "registration" via WebAuthn attestation

Parameters
- creationOptionsJSON: PublicKeyCredentialCreationOptionsJSON
  
  Output from @simplewebauthn/server's generateRegistrationOptions(...)
Returns Promise<RegistrationCredentialJSON>

Generated using TypeDoc