Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

§Interfaces

AuthenticationCredential

The credential returned from navigator.credentials.get() during WebAuthn authentication. Contains the assertion signature proving possession of the private key.

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.

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.

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.

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.

PublicKeyCredentialCreationOptionsFuture

Enhanced PublicKeyCredentialCreationOptions that knows about the latest features. Used for WebAuthn registration ceremonies.

PublicKeyCredentialCreationOptionsJSON

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

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)

PublicKeyCredentialDescriptorJSON

Represents a public key credential descriptor in JSON format. Used to identify credentials for exclusion or allowance during WebAuthn ceremonies.

PublicKeyCredentialFuture

A super class of TypeScript's PublicKeyCredential that knows about upcoming WebAuthn features. Includes WebAuthn Level 3 methods for JSON serialization and parsing.

PublicKeyCredentialRequestOptionsFuture

Enhanced PublicKeyCredentialRequestOptions that knows about the latest features. Used for WebAuthn authentication ceremonies.

PublicKeyCredentialRequestOptionsJSON

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

PublicKeyCredentialUserEntity

Represents user account information for WebAuthn registration with binary data. Contains identifiers and display information for the user being registered.

PublicKeyCredentialUserEntityJSON

Represents user account information in JSON format for WebAuthn registration. Contains identifiers and display information for the user being registered.

RegistrationCredential

The credential returned from navigator.credentials.create() during WebAuthn registration. Contains the new credential's public key and attestation information.

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.

§Type Aliases

AttestationFormat

Values for an attestation object's fmt. Defines the format of the attestation statement from the authenticator.

AuthenticatorAttachment

Specifies the preferred authenticator attachment modality.

  • platform: A platform authenticator attached to the client device (e.g., Touch ID, Windows Hello)
  • cross-platform: A roaming authenticator not attached to the client device (e.g., USB security key)
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)

Base64URLString

An attempt to communicate that this isn't just any string, but a Base64URL-encoded string. Base64URL encoding is used throughout WebAuthn for binary data transmission.

CredentialDeviceType

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

  • "singleDevice" credentials will never be backed up
  • "multiDevice" credentials can be backed up
PublicKeyCredentialHint

Categories of authenticators that Relying Parties can pass along to browsers during registration. Browsers that understand these values can optimize their modal experience to start the user off in a particular registration flow:

PublicKeyCredentialJSON

Union type for all WebAuthn credential responses in JSON format. Can be either a registration response (for new credentials) or authentication response (for existing credentials).

Uint8Array_

Equivalent to Uint8Array before TypeScript 5.7, and Uint8Array<ArrayBuffer> in TypeScript 5.7 and beyond.

WebAuthnCredential

Public key credential information needed to verify authentication responses. Stores the credential's public key and metadata for server-side verification.