Class SimpleMessagesProvider

Default messages provider that performs message lookup using key-value pairs. Provides internationalization and custom error message support for validation. Supports field-specific messages, wildcard patterns, and placeholder interpolation.

Example

const provider = new SimpleMessagesProvider({
  'required': 'The {{ field }} field is required',
  'email': 'The {{ field }} field must be a valid email',
  'user.email.required': 'Email address is required'
}, {
  'user.email': 'Email Address'
})

Implements

MessagesProviderContact

Index

Constructors

constructor

Methods

getMessage toJSON

Constructors

constructor

new SimpleMessagesProvider(
messages: ValidationMessages,
fields?: ValidationFields,
): SimpleMessagesProvider
Creates a new SimpleMessagesProvider instance.
Parameters
- messages: ValidationMessages
  Map of validation rule names to error message templates
- Optionalfields: ValidationFields
  Optional map of field paths to human-readable names
Returns SimpleMessagesProvider
Example
```
new SimpleMessagesProvider({
  'required': 'The {{ field }} field is required'
}, {
  'user_name': 'Username'
})
```
- Defined in src/messages_provider/simple_messages_provider.ts:50

Methods

getMessage

getMessage(
    rawMessage: string,
    rule: string,
    field: FieldContext,
    args?: Record<string, any>,
): string
Returns a validation error message for a given field and rule. Uses a priority-based lookup system to find the most specific message.

Priority order:
1. Field-specific messages (e.g., 'user.email.required')
2. Wildcard path messages (e.g., '*.email.required')
3. Generic rule messages (e.g., 'required')
4. Fallback to raw message
Parameters
- rawMessage: string
  The default raw message from the validation rule
- rule: string
  The name of the validation rule that failed
- field: FieldContext
  Context information about the field being validated
- Optionalargs: Record<string, any>
  Additional arguments to interpolate into the message
Returns string
Formatted and interpolated error message
Example
```
// With field-specific message
provider.getMessage('Required', 'required', fieldContext, {})
// Returns: "Email address is required" (if field-specific message exists)

// With rule arguments
provider.getMessage('Min length', 'minLength', fieldContext, { min: 5 })
// Returns: "The username must be at least 5 characters"
```
Implementation of MessagesProviderContact.getMessage
- Defined in src/messages_provider/simple_messages_provider.ts:116

toJSON

toJSON(): { messages: ValidationMessages; fields: ValidationFields }
Serializes the messages provider to a JSON-compatible object. Useful for debugging, logging, or transferring configuration.

Returns { messages: ValidationMessages; fields: ValidationFields }
Object containing messages and field mappings
Example
```
const config = provider.toJSON()
console.log(config)
// { messages: { required: "..." }, fields: { user_name: "Username" } }
```
- Defined in src/messages_provider/simple_messages_provider.ts:175

Class SimpleMessagesProvider

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SimpleMessagesProvider

Example

Methods

getMessage

Parameters

Returns string

Example

toJSON

Returns { messages: ValidationMessages; fields: ValidationFields }

Example

Settings

On This Page