caixa de tipo h3

caixa de tipo h3

Validação de esquema JSON para h3, usando typebox e ajv.

Instalar

 # Using npm
npm install h3-typebox

# Using yarn
yarn install h3-typebox

# Using pnpm
pnpm install h3-typebox

Uso

 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 )

Veja como definir seu esquema com Type na documentação TypeBox.

Opções

Você pode definir um objeto de opções em validateBody ou validateQuery . Atualmente as seguintes opções são suportadas:

• includeAjvFormats: Boolean

incluirAjvFormats

Alguns formatos como date , date-time ou email são especificados no rascunho JSONSchema atual, mas não incluídos no ajv por padrão, mas fornecidos pelo pacote ajv-formats . Se um desses formatos for necessário, você pode especificar includeAjvFormats: true nas opções de validateBody ou validateQuery assim:

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

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

Atualmente, apenas os seguintes formatos estendidos são suportados por motivos de desempenho e segurança:

• data-hora
• tempo
• data
• e-mail
• uri
• referência uri

Eles podem ser usados ​​por esquemas personalizados com o método Type.Unsafe ou com um esquema embutido:

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

Desenvolvimento

• Clonar este repositório
• Instale dependências usando pnpm install
• Execute testes interativos usando pnpm dev

Licença

Feito com?

Publicado sob licença do MIT.