Askr documentation
Generated API snapshot

@askrjs/auth/webauthn-client

Exports from the declarations published in @askrjs/auth. Signatures reflect the published artifact.

Exports

This entrypoint publishes 8 exports. Use the anchored symbol rows for direct links. Type-only exports are labeled separately from runtime values.

createPasskeytype

createPasskey: (options: CreatePasskeyOptions) => Promise<PasskeyRegistration>

Create a passkey through the browser WebAuthn API.

CreatePasskeyOptionstype

CreatePasskeyOptions: any

Registration ceremony inputs for creating a passkey.

challenge
Base64url challenge from the server.
rpId
Relying-party identifier.
rpName
Human-readable relying-party name.
userId
Base64url user identifier.
userName
User name displayed by the authenticator.
userDisplayName
Human-readable user display name.
userVerification
Required user-verification policy.

decodeBase64Urltype

decodeBase64Url: (value: string) => ArrayBuffer

Decode canonical unpadded base64url.

encodeBase64Urltype

encodeBase64Url: (buffer: ArrayBuffer) => string

Encode binary data as unpadded base64url.

getPasskeyAssertiontype

getPasskeyAssertion: (options: GetPasskeyAssertionOptions) => Promise<PasskeyAssertion>

Request a passkey assertion through the browser WebAuthn API.

GetPasskeyAssertionOptionstype

GetPasskeyAssertionOptions: any

Authentication ceremony inputs for requesting a passkey assertion.

challenge
Base64url challenge from the server.
rpId
Relying-party identifier.
allowCredentials
Optional allow-list of credential identifiers.
userVerification
Required user-verification policy.

PasskeyAssertiontype

PasskeyAssertion: any

Client-safe assertion returned to the server.

credentialId
Base64url credential identifier.
clientDataJSON
Browser client-data JSON.
authenticatorData
Authenticator data.
signature
Assertion signature.

PasskeyRegistrationtype

PasskeyRegistration: any

Client-safe registration credential returned to the server.

credentialId
Base64url credential identifier.
clientDataJSON
Browser client-data JSON.
attestationObject
Browser attestation object.