Skip to main content

Passkey

@quik/passport

@quik/passport / Passkey

Variable: Passkey

const Passkey: object

Defined in: passport/src/passkey/index.ts:23

Public passkey API exposed by @quik/passport.

Type Declaration​

cleanupChallenges​

cleanupChallenges: (now?) => number = cleanupPasskeyChallenges

Removes expired or consumed challenges from the active store.

Parameters​

now?​

number

Optional reference timestamp.

Returns​

number

clearProviders​

clearProviders: () => void = clearPasskeyProviders

Clears all registered passkey providers.

Returns​

void

createAuthenticationOptions​

createAuthenticationOptions: (input) => Promise<QPasskeyAuthenticationOptions>

Creates WebAuthn authentication options and persists the corresponding challenge.

Parameters​

input?​

QPasskeyAuthenticationInput = {}

Authentication request input.

Returns​

Promise<QPasskeyAuthenticationOptions>

createRegistrationOptions​

createRegistrationOptions: (input) => Promise<QPasskeyRegistrationOptions>

Creates WebAuthn registration options and persists the corresponding challenge.

Parameters​

input​

QPasskeyRegistrationInput

Registration request input.

Returns​

Promise<QPasskeyRegistrationOptions>

getChallengeStore​

getChallengeStore: () => IQPasskeyChallengeStore = getPasskeyChallengeStore

Returns the active passkey challenge store.

Returns​

IQPasskeyChallengeStore

getCredentialStore​

getCredentialStore: () => IQPasskeyCredentialStore = getPasskeyCredentialStore

Returns the active passkey credential store.

Returns​

IQPasskeyCredentialStore

getProvider​

getProvider: (name) => IQPasskeyProvider = getPasskeyProvider

Returns a registered passkey provider.

Parameters​

name?​

string = defaultProviderName

Provider name.

Returns​

IQPasskeyProvider

Throws​

QTranslatableError When provider is not registered.

InMemoryPasskeyChallengeStore​

InMemoryPasskeyChallengeStore: typeof InMemoryPasskeyChallengeStore

InMemoryPasskeyCredentialStore​

InMemoryPasskeyCredentialStore: typeof InMemoryPasskeyCredentialStore

setChallengeStore​

setChallengeStore: (store) => void = setPasskeyChallengeStore

Replaces the active passkey challenge store.

Parameters​

store​

IQPasskeyChallengeStore

Store implementation.

Returns​

void

setCredentialStore​

setCredentialStore: (store) => void = setPasskeyCredentialStore

Replaces the active passkey credential store.

Parameters​

store​

IQPasskeyCredentialStore

Store implementation.

Returns​

void

setProvider​

setProvider: (provider, name) => void = setPasskeyProvider

Registers a passkey provider by name.

Parameters​

provider​

IQPasskeyProvider

Provider implementation.

name?​

string = defaultProviderName

Provider name.

Returns​

void

verifyAuthentication​

verifyAuthentication: (challengeId, response, request?) => Promise<IQUser>

Verifies an authentication response through the configured provider.

Parameters​

challengeId​

string

Persisted challenge id.

response​

Record<string, unknown>

Raw client response payload.

request?​

Request

Optional HTTP request context.

Returns​

Promise<IQUser>

verifyRegistration​

verifyRegistration: (challengeId, response, request?) => Promise<boolean>

Verifies a registration response through the configured provider.

Parameters​

challengeId​

string

Persisted challenge id.

response​

Record<string, unknown>

Raw client response payload.

request?​

Request

Optional HTTP request context.

Returns​

Promise<boolean>