Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @simplewebauthn/typescript-types

Index

Interfaces

Type Aliases

Type Aliases

AttestationConveyancePreference

AttestationConveyancePreference: "direct" | "enterprise" | "indirect" | "none"

AuthenticatorAttachment

AuthenticatorAttachment: "cross-platform" | "platform"

AuthenticatorDevice

AuthenticatorDevice: { counter: number; credentialID: Buffer; credentialPublicKey: Buffer; transports?: AuthenticatorTransportFuture[] }

A WebAuthn-compatible device and the information needed to verify assertions by it

Type declaration

AuthenticatorTransport

AuthenticatorTransport: "ble" | "internal" | "nfc" | "usb"

AuthenticatorTransportFuture

AuthenticatorTransportFuture: "ble" | "internal" | "nfc" | "usb" | "cable" | "hybrid"

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

Base64URLString: string

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

BufferSource

BufferSource: ArrayBufferView | ArrayBuffer

COSEAlgorithmIdentifier

COSEAlgorithmIdentifier: number

CredentialDeviceType

CredentialDeviceType: "singleDevice" | "multiDevice"

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

PublicKeyCredentialType

PublicKeyCredentialType: "public-key"

ResidentKeyRequirement

ResidentKeyRequirement: "discouraged" | "preferred" | "required"

UserVerificationRequirement

UserVerificationRequirement: "discouraged" | "preferred" | "required"

UvmEntries

UvmEntries: UvmEntry[]

UvmEntry

UvmEntry: number[]

Generated using TypeDoc