h3 typebox

h3-поле ввода текста

Проверка схемы 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 в документации TypeBox.

Параметры

Вы можете определить объект параметров в validateBody или validateQuery . На данный момент поддерживаются следующие опции:

• includeAjvFormats: Boolean

включитьAjvFormats

Некоторые форматы, такие как 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 } ) 

Разработка

• Клонировать этот репозиторий
• Установите зависимости с помощью pnpm install
• Запуск интерактивных тестов с помощью pnpm dev

Лицензия

Сделано с?

Опубликовано по лицензии MIT.