h3 typebox

h3型盒

使用 typebox 和 ajv 对 h3 进行 JSON 模式验证。

安装

 # Using npm
npm install h3-typebox

# Using yarn
yarn install h3-typebox

# Using pnpm
pnpm install h3-typebox

用法

 import { createServer } from 'http'
import { createApp } from 'h3'
import { validateBody , validateQuery , Type } from 'h3-typebox'

const app = createApp ( )
app . use ( '/' , async ( event ) => {
  // Validate body
  const body = await validateBody ( event , Type . Object ( {
    optional : Type . Optional ( Type . String ( ) ) ,
    required : Type . Boolean ( ) ,
  } ) )

  // Validate query
  const query = validateQuery ( event , Type . Object ( {
    required : Type . String ( ) ,
  } ) )
} )

createServer ( app ) . listen ( process . env . PORT || 3000 )

请参阅 TypeBox 文档中如何使用Type定义架构。

选项

您可以在validateBody或validateQuery上定义选项对象。目前支持以下选项：

• includeAjvFormats: Boolean

包括 Ajv 格式

某些格式（例如date 、 date-time或email在当前 JSONSchema 草案中指定，但默认情况下不包含在 ajv 中，而是由ajv-formats包提供。如果需要其中一种格式，您可以在validateBody或validateQuery的选项中指定includeAjvFormats: true如下所示：

 // Body
validateBody ( event , schema , { includeAjvFormats : true } )

// Query
validateQuery ( event , schema , { includeAjvFormats : true } )

目前，出于性能和安全原因，仅支持以下扩展格式：

• 日期时间
• 时间
• 日期
• 电子邮件
• 乌里
• uri 引用

这些可以由自定义架构与Type.Unsafe方法或内联架构一起使用：

 const bodySchema = Type . Object ( {
  optional : Type . Optional ( Type . String ( ) ) ,
  dateTime : Type . String ( { format : 'date-time' } )
} )
validateBody ( event , bodySchema , { includeAjvFormats : true } ) 

发展

• 克隆这个存储库
• 使用pnpm install安装依赖项
• 使用pnpm dev运行交互式测试

执照

用？

根据麻省理工学院许可发布。