String schema

A function which creates a parsing rule to ensure that a given value is a string.

Arguments

modifiers? - A list of modifiers
- min: Learn more
- max: Learn more
- email: Learn more
- enumerator: Learn more
- custom: Learn more
- url: Learn more
- uuid: Learn more
- phone: Learn more
- ip: Learn more
- creditCard: Learn more
- trim: Learn more
- includes: Learn more
- startsWith: Learn more
- endsWith: Learn more
- slug: Learn more
- pattern: Learn more
message? - A custom object with error messages to be displayed when validation fails or there are type errors

Examples

import { string } from '@nordic-ui/validathor';
 
const stringRule = string();
 
try {
  const parsedValue = stringRule.parse('Hello world');
  console.log('Parsed value:', parsedValue);
} catch (error) {
  console.error('Parsing failed:', error.message);
}

TypeScript

To get the type of a schema, you can do the following:

const stringRule = string();
 
type StringSchema = ReturnType<typeof stringRule.parse>; // string

Regex Tuple