Class MetaModifier<Schema>

constructor

• new MetaModifier<Schema extends ConstructableLiteralSchema<any, any, any>>(
      parent: Schema,
      meta: JSONSchema7,
  ): MetaModifier<Schema>

  Type Parameters

  • Schema extends ConstructableLiteralSchema<any, any, any>

  Parameters

  • parent: Schema
  • meta: JSONSchema7

  Returns MetaModifier<Schema>

[ITYPE]

[OTYPE]

[COTYPE]

isOptional

• get isOptional(): boolean | undefined

  Returns boolean | undefined

allowNull

• get allowNull(): boolean | undefined

  Returns boolean | undefined

optional

• optional(): OptionalModifier<MetaModifier<Schema>>

  Mark the field under validation as optional. An optional field allows both null and undefined values.

  Returns OptionalModifier<MetaModifier<Schema>>

transform

• transform<TransformedOutput>(
      transformer: Transformer<MetaModifier<Schema>, TransformedOutput>,
  ): TransformModifier<MetaModifier<Schema>, TransformedOutput>

  Apply a transformation to the final validated value. The transformer receives the validated value and can convert it to any new datatype.

  Type Parameters

  • TransformedOutput

    The type of the transformed output

  Parameters

  • transformer: Transformer<MetaModifier<Schema>, TransformedOutput>

    Function to transform the validated value

  Returns TransformModifier<MetaModifier<Schema>, TransformedOutput>

  A new TransformModifier wrapping this schema

  Example

  vine.string().nullable().transform((value) => {
    return value ? value.toUpperCase() : null
  })
  Copy

nullable

• nullable(): NullableModifier<MetaModifier<Schema>>

  Mark the field under validation to be null. The null value will be written to the output as well.

  If optional and nullable are used together, then both undefined and null values will be allowed.

  Returns NullableModifier<MetaModifier<Schema>>

clone

• clone(): this

  Creates a fresh instance of the underlying schema type and wraps it inside the meta modifier

  Returns this

toJSONSchema

• toJSONSchema(): JSONSchema7

  Transforms your schema type into JSONSchema7

  Returns JSONSchema7

[PARSE]

• "[PARSE]"(
      propertyName: string,
      refs: RefsStore,
      options: ParserOptions,
  ): FieldNode & {} & { subtype: string }

  Compiles to compiler node

  Parameters

  • propertyName: string
  • refs: RefsStore
  • options: ParserOptions

  Returns FieldNode & {} & { subtype: string }