mimeType

Creates a pipeline validation action that validates the MIME type of a blob.

const Validation = mimeType<TInput, TRequirement>(requirement, message);

Generics

• TInput extends Blob
• TRequirement extends string[]

Parameters

• requirement TRequirement
• message ErrorMessage | undefined

Explanation

With mimeType you can validate the MIME type of a blob. If the input does not match the requirement, you can use message to customize the error message.

Returns

• Validation MimeTypeValidation<TInput, TRequirement>

Examples

The following examples show how mimeType can be used.

Image schema

Schema to validate an image file.

const ImageSchema = blob([
  mimeType(['image/jpeg', 'image/png'], 'Please select a JPEG or PNG file.'),
]);

Related

The following APIs can be combined with mimeType.

Schemas

• any,
• blob,
• instance,
• special,
• unknown