Skip to main content

TypeScript types used by the @simplewebauthn series of libraries

This package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
This package works with Browsers
JSR Score
88%
Published
3 months ago (12.0.0)
T
AttestationConveyancePreference
No documentation available
I
AuthenticationCredential

The value returned from navigator.credentials.get()

I
AuthenticationResponseJSON

A slightly-modified AuthenticationCredential to simplify working with ArrayBuffers that are Base64URL-encoded in the browser so that they can be sent as JSON to the server.

I
AuthenticatorAssertionResponseJSON

A slightly-modified AuthenticatorAssertionResponse to simplify working with ArrayBuffers that are Base64URL-encoded in the browser so that they can be sent as JSON to the server.

T
AuthenticatorAttachment
No documentation available
I
AuthenticatorAttestationResponseFuture

AuthenticatorAttestationResponse in TypeScript's DOM lib is outdated (up through v3.9.7). Maintain an augmented version here so we can implement additional properties as the WebAuthn spec evolves.

I
AuthenticatorAttestationResponseJSON

A slightly-modified AuthenticatorAttestationResponse to simplify working with ArrayBuffers that are Base64URL-encoded in the browser so that they can be sent as JSON to the server.

T
AuthenticatorTransport
No documentation available
T
AuthenticatorTransportFuture

A super class of TypeScript's AuthenticatorTransport that includes support for the latest transports. Should eventually be replaced by TypeScript's when TypeScript gets updated to know about it (sometime after 4.6.3)

T
Base64URLString

An attempt to communicate that this isn't just any string, but a Base64URL-encoded string

T
COSEAlgorithmIdentifier
No documentation available
T
CredentialDeviceType

The two types of credentials as defined by bit 3 ("Backup Eligibility") in authenticator data:

I
Crypto

Basic cryptography features available in the current context. It allows access to a cryptographically strong random number generator and to cryptographic primitives.

I
PublicKeyCredentialCreationOptionsJSON

A variant of PublicKeyCredentialCreationOptions suitable for JSON transmission to the browser to (eventually) get passed into navigator.credentials.create(...) in the browser.

I
I
PublicKeyCredentialDescriptorFuture

A super class of TypeScript's PublicKeyCredentialDescriptor that knows about the latest transports. Should eventually be replaced by TypeScript's when TypeScript gets updated to know about it (sometime after 4.6.3)

I
PublicKeyCredentialFuture

A super class of TypeScript's PublicKeyCredential that knows about upcoming WebAuthn features

T
PublicKeyCredentialJSON
No documentation available
I
PublicKeyCredentialParameters
No documentation available
I
PublicKeyCredentialRequestOptionsJSON

A variant of PublicKeyCredentialRequestOptions suitable for JSON transmission to the browser to (eventually) get passed into navigator.credentials.get(...) in the browser.

I
PublicKeyCredentialRpEntity
No documentation available
T
PublicKeyCredentialType
No documentation available
I
PublicKeyCredentialUserEntity
No documentation available
I
RegistrationCredential

The value returned from navigator.credentials.create()

I
RegistrationResponseJSON

A slightly-modified RegistrationCredential to simplify working with ArrayBuffers that are Base64URL-encoded in the browser so that they can be sent as JSON to the server.

T
UserVerificationRequirement
No documentation available
T
WebAuthnCredential

Public key credential information needed to verify authentication responses