string

Validates the property to be a valid string.

import { schema } from '@ioc:Adonis/Core/Validator'

{
  title: schema.string()
}

Mark as optional

You can mark the property to be optional by chaining the optional method. The undefined and the null values are considered optional and removed from the validated object.

{
  title: schema.string.optional()
}

Mark as nullable

You can mark the property to be nullable by chaining the nullable method. The nullable fields must exist in the payload but can contain null values.

{
  title: schema.string.nullable()
}

Mark as nullable and optional

Mark the property both as nullable and optional. If the field value is undefined, it will be removed from the validated object. Otherwise, the validated value (including null) is returned.

{
  title: schema.string.nullableAndOptional()
}

Define additional rules

You can define an array of additional rules as the second parameter.

import { schema, rules } from '@ioc:Adonis/Core/Validator'

{
  title: schema.string([
    rules.alpha(),
    rules.minLength(10),
    rules.maxLength(200),
    rules.trim(),
    rules.escape(),
  ])
}

Edit this page on GitHub