Class NullableModifier<Schema>

constructor

• new NullableModifier<Schema extends ConstructableLiteralSchema<any, any, any>>(
      parent: Schema,
  ): NullableModifier<Schema>

  Type Parameters

  • Schema extends ConstructableLiteralSchema<any, any, any>

  Parameters

  • parent: Schema

  Returns NullableModifier<Schema>

[ITYPE]

[OTYPE]

[COTYPE]

clone

• clone(): this

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

  Returns this

optional

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

  Mark the field under validation as optional. When combined with nullable, allows both null and undefined values.

  Returns OptionalModifier<NullableModifier<Schema>>

  A new OptionalModifier wrapping this nullable schema

transform

• transform<TransformedOutput>(
      transformer: Transformer<NullableModifier<Schema>, TransformedOutput>,
  ): TransformModifier<NullableModifier<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<NullableModifier<Schema>, TransformedOutput>

    Function to transform the validated value

  Returns TransformModifier<NullableModifier<Schema>, TransformedOutput>

  A new TransformModifier wrapping this schema

  Example

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

[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 }