resolveFieldMask

resolveFieldMask(props): FieldMask | undefined

Defined in: packages/core/src/fields/mask/utils.ts:46

Resolves a field’s effective mask from its own admin.mask and the project’s fields.inputMasks[fieldType] default.

fieldMask: false always disables masking, even when the project configured a default for this field type. fieldMask: undefined falls back to the project default, if any. Any other fieldMask overrides the project default entirely (contract item 8 — opt-in only, no merging of the two).

Parameters

props

Input props.

fieldMask

false | FieldMaskInput | undefined

The field’s own admin.mask value.

fieldType

MaskableFieldType

The field’s own type, used to look up the project default.

inputMasks

Partial<Record<MaskableFieldType, FieldMaskInput>>

The project’s fields.inputMasks defaults, keyed by field type.

Returns

FieldMask | undefined

The resolved mask, or undefined when no mask applies.

Example

resolveFieldMask({ fieldType: "number", fieldMask: undefined, inputMasks: { number: "decimal" } })
// → { mask: "decimal", storeMasked: false, options: {} }

resolveFieldMask({ fieldType: "number", fieldMask: false, inputMasks: { number: "decimal" } })
// → undefined