mac

Creates a pipeline validation action that validates a MAC address.

This validation action accepts 48-bit and 64-bit MAC addresses. For a more specific validation, you can also use mac48 or mac64.

const Validation = mac<TInput>(message);

Generics

• TInput extends string

Parameters

• message ErrorMessage | undefined

Explanation

With mac you can validate the formatting of a string. If the input is not a MAC address, you can use message to customize the error message.

Returns

• Validation MacValidation<TInput>

Examples

The following examples show how mac can be used.

MAC schema

Schema to validate a MAC address.

const MacSchema = string([mac('The MAC address is badly formatted.')]);

Related

The following APIs can be combined with mac.

Schemas

• any,
• special,
• string,
• unknown