emoji

Creates a pipeline validation action that validates an emoji.

const Validation = emoji<TInput>(message);

Generics

• TInput extends string

Parameters

• message ErrorMessage | undefined

Explanation

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

Returns

• Validation EmojiValidation<TInput>

Examples

The following examples show how emoji can be used.

Emoji schema

Schema to validate an emoji.

const EmojiSchema = string([emoji('Please provide a valid emoji.')]);

Related

The following APIs can be combined with emoji.

Schemas

• any,
• special,
• string,
• unknown