Skip to main content

string

npm Package Size Security Scorecard CI

Use this schema to validate strings with optional chain validators.

import {string} from '@livon/schema';

const UserName = string().min(3).max(20);

const value = UserName.parse('alice');

Parameters​

  • name (string, optional): schema node name. Default: 'string'.
  • doc (SchemaDoc, optional): schema metadata attached to AST/doc output.

Chain API​

  • .min(min: number): Schema<string>: requires value.length >= min.
  • .max(max: number): Schema<string>: requires value.length <= max.
  • .email(): Schema<string>: requires a valid email format.
  • .regex(pattern: RegExp): Schema<string>: requires pattern.test(value) === true.

Shared methods on current type T = string: optional(): Schema<T | undefined>, nullable(): Schema<T | null>, describe(doc: SchemaDoc): Schema<T>, refine(input): Schema<T>, before(hook): Schema<T>, after<U>(hook): Schema<U>, and<U>(other: Schema<U>, options?: {name?: string}): Schema<T & U>.