@amazon/ 乙烯认证
TypeScript 第一个用于运行时类型检查和计划验证库 审定。 原始、对象、阵列、组合、, 记录、拖累、功能和结合,对结果作出强有力的推断 类型.
安装
npm install @amazon/vinyl-validation
基本用途
import { string, number } from '@amazon/vinyl-validation'
const nameValidator = string().notEmpty()
const ageValidator = number().gte(0)
nameValidator.isValid('John') // true
ageValidator.isValid(-5) // false
// Get validation errors
const errors = nameValidator.validate('')
// [{ message: 'Expected: not empty, but was: "". At: ', path: [] }]
核心验证器
初级类型
import { string, number, boolean, symbol, any } from '@amazon/vinyl-validation'
const stringValidator = string()
const numberValidator = number()
const booleanValidator = boolean()
const symbolValidator = symbol()
const anyValidator = any() // accepts any value
无效和未定义
import {
exactlyNull,
exactlyUndefined,
nullish,
} from '@amazon/vinyl-validation'
const nullValidator = exactlyNull() // only null
const undefinedValidator = exactlyUndefined() // only undefined
const nullishValidator = nullish() // null or undefined
数值匹配
import { isOneOf, instanceOf } from '@amazon/vinyl-validation'
const statusValidator = isOneOf('active', 'inactive', 'pending')
const dateValidator = instanceOf(Date)
const errorValidator = instanceOf(Error)
字符串验证
import { string } from '@amazon/vinyl-validation'
const validator = string()
.notEmpty()
.minLength(3)
.maxLength(50)
.noWhitespace()
.matches(/^[a-z]+$/)
validator.isValid('hello') // true
validator.isValid('') // false (empty)
validator.isValid('ab') // false (too short)
数量验证
import { number } from '@amazon/vinyl-validation'
const validator = number().gte(0).lte(100).within(1, 99).safeInteger().finite()
validator.isValid(50) // true
validator.isValid(-1) // false (less than 0)
validator.isValid(Infinity) // false (not finite)
对象验证
import {
object,
string,
number,
isOneOf,
array,
} from '@amazon/vinyl-validation'
const userValidator = object({
name: string().notEmpty(),
age: number().gte(0),
email: string().matches(/^[^\s@]+@[^\s@]+\.[^\s@]+$/),
})
const user = { name: 'John', age: 30, email: '[email protected]' }
userValidator.isValid(user) // true
// Extend existing schemas
const adminValidator = userValidator.extend({
role: isOneOf('admin', 'superadmin'),
permissions: array(string()),
})
阵列验证
import { array, string, number, tuple, boolean } from '@amazon/vinyl-validation'
const stringArrayValidator = array(string())
const numberArrayValidator = array(number().gte(0))
.minLength(1)
.maxLength(10)
.notEmpty()
// Tuples (fixed-length, positional)
const coordinateValidator = tuple(number(), number()) // [x, y]
const personValidator = tuple(string(), number(), boolean()) // [name, age, active]
stringArrayValidator.isValid(['a', 'b', 'c']) // true
coordinateValidator.isValid([10, 20]) // true
coordinateValidator.isValid([10, 20, 30]) // false (wrong length)
记录验证
import { record, recordValues, string, number } from '@amazon/vinyl-validation'
const scoresValidator = recordValues(number().gte(0))
const configValidator = record(
string().matches(/^[A-Z_]+$/),
string().notEmpty()
)
scoresValidator.isValid({ alice: 95, bob: 87 }) // true
configValidator.isValid({ API_KEY: 'secret', DB_URL: 'localhost' }) // true
设置验证
import { set, string } from '@amazon/vinyl-validation'
const tagValidator = set(string().notEmpty())
tagValidator.isValid(new Set(['tag1', 'tag2'])) // true
tagValidator.isValid(new Set(['tag1', ''])) // false (empty string)
函数验证
import { func } from '@amazon/vinyl-validation'
const functionValidator = func().withArity(2).withMinArity(1).withMaxArity(3)
functionValidator.isValid((a, b) => a + b) // true
functionValidator.isValid(() => 'hello') // false (wrong arity)
可选和可忽略的数值
import { string } from '@amazon/vinyl-validation'
const optionalName = string().optional() // allows undefined
const nullableName = string().nullable() // allows null
const maybeName = string().maybe() // allows null or undefined
optionalName.isValid(undefined) // true
nullableName.isValid(null) // true
maybeName.isValid(null) // true
maybeName.isValid(undefined) // true
组合验证器
逻辑
import { orValidators, string, number } from '@amazon/vinyl-validation'
const stringOrNumber = orValidators(string(), number())
stringOrNumber.isValid('hello') // true
stringOrNumber.isValid(42) // true
stringOrNumber.isValid(true) // false
逻辑
import { andValidators, string } from '@amazon/vinyl-validation'
const shortUppercaseString = andValidators(
string().maxLength(10),
string().matches(/^[A-Z]+$/)
)
shortUppercaseString.isValid('HELLO') // true
shortUppercaseString.isValid('hello') // false (not uppercase)
shortUppercaseString.isValid('VERYLONGSTRING') // false (too long)
自定义验证器
import { custom } from '@amazon/vinyl-validation'
const evenNumberValidator = custom<number>(
'even number',
(input): input is number => typeof input === 'number' && input % 2 === 0
)
evenNumberValidator.isValid(4) // true
evenNumberValidator.isValid(3) // false
验证选项
import { string, object } from '@amazon/vinyl-validation'
const validator = object({
name: string().notEmpty(),
email: string().matches(/^[^\s@]+@[^\s@]+\.[^\s@]+$/),
})
// Collect all errors (default: stop at first error)
const errors = validator.validate({ name: '', email: 'invalid' }, { all: true })
处理错误
import { ValidationError } from '@amazon/vinyl-util'
import { string } from '@amazon/vinyl-validation'
const validator = string().notEmpty()
try {
validator.assert('') // throws ValidationError if invalid
} catch (error) {
if (error instanceof ValidationError) {
console.log(error.message)
}
}
类型脚本集成
import { object, string, number, array } from '@amazon/vinyl-validation'
interface User {
name: string
age?: number
tags: string[]
}
const userValidator = object<User>({
name: string(),
age: number().optional(),
tags: array(string()),
})
function processUser(data: unknown) {
if (userValidator.isValid(data)) {
console.log(data.name) // typed as string
}
}
说明和 JSON Schema 导出
任何计划节点都可以携带人可读的描述 任何计划都可以
导出为 a 杰森·斯克马 定义。 这个有用
用于描述一个形状给LLM或另一个消费者,并且工作类似
泽德的 describe 财务报告和审定财务报表 zod-to-json-schema。 。 。 .
import {
object,
string,
number,
isOneOf,
toJsonSchema,
} from '@amazon/vinyl-validation'
const userSchema = object({
name: string().notEmpty().describe('The user full name'),
age: number().gte(0).lte(120),
role: isOneOf('admin', 'user').describe('Access level'),
nickname: string().optional(),
}).describe('A user record')
toJsonSchema(userSchema)
// {
// type: 'object',
// properties: {
// name: { type: 'string', minLength: 1, description: 'The user full name' },
// age: { type: 'number', minimum: 0, maximum: 120 },
// role: { enum: ['admin', 'user'], description: 'Access level' },
// nickname: { type: 'string' },
// },
// required: ['name', 'age', 'role'],
// description: 'A user record',
// }
describe ;它不影响验证。 可选属性
被删除 required 列表中选择一个选项。 工会or, (中文(简体) ), maybe导出为 anyOf, (中文(简体) ),
数组为 items,tuples作为位置 items,设置为唯一项目数组,以及
记录为输入对象 additionalProperties。 。 。 .
许可证
阿帕奇 - 2.0