useRules API

API reference for the useRules composable.

Functions

(_options?: RulesOptions) => RulesContext

Creates a new rules instance.

() => RulesContext

Creates a fallback rules instance for use outside component scope. No locale lookup — `false` returns fall back to the alias name.

typeof isStandardSchema

<_E>(_options?: RulesContextOptions | undefined) => ContextTrinity<_E>

(_options?: RulesContextOptions | undefined) => Plugin

<_E>(namespace?: string) => _E

Partial<RuleAliases> | undefined

Custom aliases to register. Each alias is a predicate (FormValidationRule).

RuleAliases

The alias map (custom aliases registered via options).

(rules: RuleInput[]) => FormValidationRule[]

Resolve aliases, functions, and Standard Schema objects to FormValidationRule[].