Skip to content

Home
CLI
Guide
API

Sidebar Navigation

Guide

Getting Started
Advanced Usage
Plugins
Hooks
Troubleshooting

Apps / Tools

Command Line (CLI)

Other Topics

Testing
Security Considerations
Danger Zone
Runtime Compatibility
RFC Implementations
Fuzz Tests
Benchmarks

Migrations

Migrating v11 to v13
Migrating v12 to v13

API Reference

@otplib/core
- errors
  - Classes
    AfterTimeStepError
    AfterTimeStepNegativeError
    AfterTimeStepNotIntegerError
    AfterTimeStepRangeExceededError
    AlgorithmError
    AlgorithmUnsupportedError
    Base32DecodeError
    Base32EncodeError
    Base32Error
    Base32PluginMissingError
    ConfigurationError
    CounterError
    CounterNegativeError
    CounterNotIntegerError
    CounterOverflowError
    CounterToleranceError
    CounterToleranceNegativeError
    CounterToleranceTooLargeError
    CryptoError
    CryptoPluginMissingError
    DigitsError
    EpochToleranceError
    EpochToleranceNegativeError
    EpochToleranceTooLargeError
    HMACError
    IssuerMissingError
    LabelMissingError
    OTPError
    PeriodError
    PeriodTooLargeError
    PeriodTooSmallError
    PluginError
    RandomBytesError
    SecretError
    SecretMissingError
    SecretTooLongError
    SecretTooShortError
    SecretTypeError
    TimeError
    TimeNegativeError
    TimeNotFiniteError
    TokenError
    TokenFormatError
    TokenLengthError
    Type Aliases
    AlgorithmUnsupportedContext
    OTPErrorOptions
  types
  - Type Aliases
    Base32EncodeOptions
    Base32Plugin
    CryptoPlugin
    Digits
    HashAlgorithm
    OTPHooks
    OTPResult
    OTPResultError
    OTPResultOk
    SecretOptions
  utils
  - Type Aliases
    NormalizeHashAlgorithmOptions
    OTPGuardrails
    OTPGuardrailsConfig
    Variables
    DEFAULT_PERIOD
    HASH_ALGORITHMS
    MAX_COUNTER
    MAX_PERIOD
    MAX_SECRET_BYTES
    MAX_WINDOW
    MIN_PERIOD
    MIN_SECRET_BYTES
    RECOMMENDED_SECRET_BYTES
    Functions
    bytesToString
    constantTimeEqual
    counterToBytes
    createGuardrails
    dynamicTruncate
    generateSecret
    getDigestSize
    hasGuardrailOverrides
    normalizeCounterTolerance
    normalizeEpochTolerance
    normalizeHashAlgorithm
    normalizeSecret
    requireBase32Plugin
    requireBase32String
    requireCryptoPlugin
    requireIssuer
    requireLabel
    requireSecret
    stringToBytes
    truncateDigits
    validateByteLengthEqual
    validateCounter
    validateCounterTolerance
    validateEpochTolerance
    validatePeriod
    validateSecret
    validateTime
    validateToken
    wrapResult
    wrapResultAsync
@otplib/hotp
- Classes
  - HOTP
  Type Aliases
  - CryptoPlugin
    Digits
    HashAlgorithm
    HOTPGenerateOptions
    HOTPOptions
    HOTPVerifyOptions
    OTPResult
    VerifyResult
    VerifyResultInvalid
    VerifyResultValid
  Functions
  - generate
    generateSync
    verify
    verifySync
    wrapResult
    wrapResultAsync
@otplib/plugin-base32-alt
- Type Aliases
  - CreateBase32PluginOptions
  Variables
  - bypassAsBase16
    bypassAsBase64
    bypassAsHex
    bypassAsString
  Functions
  - createBase32Plugin
@otplib/plugin-base32-scure
- Classes
  - ScureBase32Plugin
  Variables
  - base32
@otplib/plugin-crypto-noble
- Classes
  - NobleCryptoPlugin
  Variables
  - crypto
@otplib/plugin-crypto-node
- Classes
  - NodeCryptoPlugin
  Variables
  - crypto
@otplib/plugin-crypto-web
- Classes
  - WebCryptoPlugin
  Variables
  - crypto
@otplib/totp
- Classes
  - TOTP
  Type Aliases
  - CryptoPlugin
    Digits
    HashAlgorithm
    OTPResult
    TOTPGenerateOptions
    TOTPOptions
    TOTPVerifyOptions
    VerifyResult
    VerifyResultInvalid
    VerifyResultValid
  Functions
  - generate
    generateSync
    getRemainingTime
    getTimeStepUsed
    verify
    verifySync
    wrapResult
    wrapResultAsync
@otplib/uri
- Classes
  - InvalidParameterError
    InvalidURIError
    MissingParameterError
    URIParseError
  Type Aliases
  - HOTPURIOptions
    OTPAuthParams
    OTPAuthURI
    OTPType
    TOTPURIOptions
    URIOptions
  Functions
  - generate
    generateHOTP
    generateTOTP
    parse
otplib
- class
  - Classes
    OTP
    Type Aliases
    OTPClassOptions
    OTPGenerateOptions
    OTPURIGenerateOptions
    OTPVerifyOptions
    VerifyResult
  functional
  - Type Aliases
    VerifyResult
    Functions
    generate
    generateSecret
    generateSync
    generateURI
    verify
    verifySync

On this page

otplib API Documentation / otplib / class

class

Classes

OTP

Type Aliases

OTPClassOptions
OTPGenerateOptions
OTPURIGenerateOptions
OTPVerifyOptions
VerifyResult

Pager

Previous pageotplib

Released under the MIT License.

Copyright © 2026 Gerald Yeo