cuadro de tipo h3

cuadro de tipo h3

Validación del esquema JSON para h3, usando typebox y 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 )

Vea cómo definir su esquema con Type en la documentación de TypeBox.

Opciones

Puede definir un objeto de opciones en validateBody o validateQuery . Actualmente se admiten las siguientes opciones:

• includeAjvFormats: Boolean

incluirAjvFormats

Algunos formatos como date , date-time o email se especifican en el borrador actual de JSONSchema, pero no se incluyen en ajv de forma predeterminada, sino que se proporcionan en el paquete ajv-formats . Si se necesita uno de estos formatos, puede especificar includeAjvFormats: true en las opciones de validateBody o validateQuery de esta manera:

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

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

Actualmente, solo se admiten los siguientes formatos extendidos por motivos de rendimiento y seguridad:

• fecha-hora
• tiempo
• fecha
• correo electrónico
• uri
• referencia-uri

Estos pueden ser utilizados por esquemas personalizados con el método Type.Unsafe o con un esquema en línea:

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

Desarrollo

• Clonar este repositorio
• Instalar dependencias usando pnpm install
• Ejecute pruebas interactivas usando pnpm dev

Licencia

Hecho con ?

Publicado bajo licencia MIT.