@lsby/ts_type_check NPM

ts_type_check

在 ts 中, 运行时检查数据类型.

安装

npm i @lsby/ts_type_check

使用

先编写类型文件:

// data.ts

export interface 请求数据 {
    a: number
    b: number
}
export interface 返回数据 {
    结果: number
}

然后编写程序:

// index.ts

import path from 'path'
import ts_type_check from '@lsby/ts_type_check'

async function main() {
    var 验证器 = ts_type_check(path.resolve(__dirname, './data.ts'))
    验证器.构建缓存()
    var 结果1 = await 验证器.验证('请求数据', { a: 1, b: 1 })
    console.log(结果1)
    var 结果2 = await 验证器.验证('返回数据', { 结果: 2 })
    console.log(结果2)
}

main()

注意事项

类型声明必须写在单独的文件里.
验证前程序会读取类型文件和解析格式描述, 速度较慢, 因此使用了缓存文件.
- 缓存文件名为<ts类型文件名>.typeCheck, 类型文件的 md5, 当发现文件变化后会重新生成.
- 可以在适当的时机调用构建缓存函数手动进行缓存.
- 如果未调用构建缓存, 直接进行验证的话, 会在第一次验证时构建缓存.