@eryx/schema/string Module

String schema primitives. Supports string validation rules and post-parse string transformations. Use validators for acceptance criteria and mutators for canonical output.

API Reference

Types

StringSchema

type StringSchema = t.Schema<string> & { _type: { type: "string", metadata: StringMetadata }, maxLen: ((self: StringSchema, len: number) → StringSchema), minLen: ((self: StringSchema, len: number) → StringSchema), length: ((self: StringSchema, len: number) → StringSchema), match: ((self: StringSchema, pattern: string) → StringSchema), regex: ((self: StringSchema, pattern: string) → StringSchema), startsWith: ((self: StringSchema, pattern: string) → StringSchema), endsWith: ((self: StringSchema, pattern: string) → StringSchema), includes: ((self: StringSchema, pattern: string) → StringSchema), isUpperCase: ((self: StringSchema) → StringSchema), isLowerCase: ((self: StringSchema) → StringSchema), trimWhitespace: ((self: StringSchema) → StringSchema), toUpperCase: ((self: StringSchema) → StringSchema), toLowerCase: ((self: StringSchema) → StringSchema) }
Implements: t.Schema
StringSchema:maxLen(len: number)StringSchema

Validators

StringSchema:minLen(len: number)StringSchema
StringSchema:length(len: number)StringSchema
StringSchema:match(pattern: string)StringSchema
StringSchema:regex(pattern: string)StringSchema
StringSchema:startsWith(pattern: string)StringSchema
StringSchema:endsWith(pattern: string)StringSchema
StringSchema:includes(pattern: string)StringSchema
StringSchema:isUpperCase()StringSchema
StringSchema:isLowerCase()StringSchema
StringSchema:trimWhitespace()StringSchema

Post-parse mutators

StringSchema:toUpperCase()StringSchema
StringSchema:toLowerCase()StringSchema