تنزيل h3 typebox - تنزيل كود مصدر h3 typebox

h3 صندوق الكتابة

شفرة المصدر الأخرى

v0.6.0

تنزيل

h3-typebox

التحقق من صحة مخطط JSON لـ h3، باستخدام typebox وajv.

ثَبَّتَ

 # 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 )

تعرف على كيفية تحديد مخططك باستخدام وثائق Type on TypeBox.

خيارات

يمكنك تحديد كائن خيارات على validateBody أو validateQuery . حاليًا يتم دعم الخيارات التالية:

includeAjvFormats: Boolean

includeAjvFormats

يتم تحديد بعض التنسيقات مثل date أو date-time أو email في مسودة JSONSchema الحالية، ولكنها غير مضمنة في ajv افتراضيًا، ولكنها مقدمة من خلال حزمة ajv-formats . إذا كانت هناك حاجة إلى أحد هذه التنسيقات، فيمكنك تحديد includeAjvFormats: true في خيارات validateBody أو validateQuery مثل هذا:

 // 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 } )