README

@quik/mfa

---

@quik/mfa

Namespaces

• Module

Classes

• InMemoryMFAChallengeStore
• MFADisabledError
• MFAFactorNotRegisteredError
• MFAMissingDeliveryTargetError
• QAbstractMFAChallengeStore
• QCodeFactor
• QEmailCodeFactor
• QMFAError
• QMFAService
• QSMSCodeFactor
• QTOTPFactor
• QWhatsAppCodeFactor

Interfaces

• IQMFAChallengeStore
• IQMFAFactor
• IQMFAPolicyEngine
• QMFAChallenge
• QMFAIssueInput
• QMFAIssueResult
• QMFAPolicyResolveRequestInput
• QMFAPolicyResolveStepUpInput
• QMFARequestInput
• QMFAStepUpRequirement
• QMFATOTPEnrollment
• QMFATOTPEnrollmentInput
• QMFAVerifyInput
• QMFAVerifyRequestInput
• QMFAVerifyResult

Type Aliases

• CodeDeliveryFn
• IQEmailCodeMetadata
• IQSMSCodeMetadata
• IQWhatsAppCodeMetadata
• MFAMethodType
• QCodeFactorOptions
• QMFAMethod
• QMFAResolvedRequest
• QMFAServiceOptions
• QMFATypedIssueInput
• QMFATypedRequestInput
• QTOTPFactorOptions
• QTOTPSecretResolver

Variables

• FactorsStore
• MFAMethod

Functions

• allFactors
• clearFactors
• clearMFAPolicyEngine
• createTOTPAuthUrl
• createTOTPQRCodeUrl
• createTOTPSecret
• generateTOTP
• getFactor
• getMFAChallengeStore
• getMFAPolicyEngine
• hasFactor
• registerFactor
• setMFAChallengeStore
• setMFAPolicyEngine
• verifyTOTP