简介
@types/speakeasy 是一个用于 TypeScript 开发的 speakeasy 类型声明库，旨在提供一种类型安全、便于使用的方式来控制身份验证器的生成和验证。
通过使用 @types/speakeasy，我们可以在 TypeScript 代码中方便地进行身份验证，避免因类型不匹配而导致的错误。
安装
使用 @types/speakeasy 需要在项目中安装它以及 speakeasy 本身，可以使用 npm 或者 yarn 安装:
npm install speakeasy @types/speakeasy --save # 或者 yarn add speakeasy @types/speakeasy
使用
生成身份验证器
要生成一个身份验证器需要引入 speakeasy：
import * as speakeasy from 'speakeasy'
然后使用 speakeasy.totp() 方法生成身份验证器，可以通过以下选项进行配置：
| 参数 | 类型 | 描述 |
|---|---|---|
secret |
string |
加密密钥，必填项 |
encoding |
string |
加密方式，可选项，可以是ascii 或者 base32，默认是 ascii |
time |
number |
时间窗口，可选项，单位为秒，默认是 30 |
digits |
number |
身份验证码位数，可选项，默认是 6 |
algorithm |
string |
哈希算法，可选项，可以是sha1、sha256、sha512，默认是 sha1 |
下面是一个生成身份验证器的示例：
const secret = 'K73GTM2WJZJM7RSAZT3KZT7T3TADLJAZ'
const totp = speakeasy.totp({
secret: secret,
algorithm: 'sha256',
digits: 8
})
console.log(totp)验证身份证码
要验证一个身份验证码需要引入 speakeasy：
import * as speakeasy from 'speakeasy'
然后使用 speakeasy.totp.verify() 方法进行验证，需要传入以下参数：
| 参数 | 类型 | 描述 |
|---|---|---|
encoding |
string |
加密方式，可选项，可以是ascii 或者 base32，默认是 ascii |
time |
number |
时间窗口，可选项，单位为秒，默认是 30 |
digits |
number |
身份验证码位数，可选项，默认是 6 |
algorithm |
string |
哈希算法，可选项，可以是sha1、sha256、sha512，默认是 sha1 |
下面是一个验证身份码的示例：
-- -------------------- ---- ------- ----- ------ - ---------------------------------- ----- ---- - ---------- ----- -------- - ----------------------- ------- ------- ---------- --------- ------- -- --------- --------- ------ ---- -- ---------------------
总结
@types/speakeasy 是一个非常实用的工具，它为我们提供了一种类型安全、便于使用的方式来进行身份验证工作。通过本文所提供的使用教程，我们可以快速理解该包的使用方式，并在实际项目中应用它。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedaeb4b5cbfe1ea0610eb5