Skip to content

otplib API Documentation / otplib / VerifyResult

Type Alias: VerifyResult

VerifyResult = VerifyResultValid | VerifyResultInvalid

Defined in: totp/src/types.ts:178

Result of OTP verification (discriminated union)

Use type narrowing to access delta:

ts
const result = await verify({ secret, token, epochTolerance: 30 });
if (result.valid) {
  // TypeScript knows delta exists here
  if (result.delta !== 0) {
    console.log(`Clock drift detected: ${result.delta} periods`);
  }
  console.log(`Token matched at epoch: ${result.epoch}`);
}

Released under the MIT License.