resolveMaskConfig

Mask
stable

Normalise the polymorphic mask prop (built-in key string, raw pattern string, or IMaskOptions object) into a fully resolved IResolvedMaskConfig object. Returns null for empty/absent values.

API

Signature

Full TypeScript signature sourced from the util file.

typescript

API

Parameters

Input parameters accepted by this util.

mask
required
TMask | undefined
The mask value to normalise: a registered built-in key (e.g. "date", "phone"), a raw pattern string, an IMaskOptions object, or null/undefined/empty string (returns null).

API

Return value

The value returned by this util.

A fully resolved { pattern, validator, required } object for use by the mask engine, or null when no mask is provided.

Usage

Examples

Ready-to-paste usage snippets.

Resolve built-in key and raw pattern

typescript