blob

Creates a blob schema.

// Blob schema with an optional pipe
const Schema = blob(pipe);

// Blob schema with an optional message and pipe
const Schema = blob(message, pipe);

Parameters

• message ErrorMessage | undefined
• pipe Pipe<Blob> | undefined

Explanation

With blob you can validate the data type of the input and with pipe you can transform and validate the further details of the blob. If the input is not a blob, you can use message to customize the error message.

Returns

• Schema BlobSchema

Examples

The following examples show how blob can be used.

Image schema

Schema to validate an image.

const ImageSchema = blob('Please select an image file.', [
  mimeType(['image/jpeg', 'image/png'], 'Please select a JPEG or PNG file.'),
  maxSize(1024 * 1024 * 10, 'Please select a file smaller than 10 MB.'),
]);

Related

The following APIs can be combined with blob.

Schemas

• array,
• intersect,
• lazy,
• map,
• nonNullable,
• nonNullish,
• nonOptional,
• nullable,
• nullish,
• object,
• optional,
• record,
• set,
• tuple,
• union

Methods

• brand,
• coerce,
• fallback,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• parse,
• safeParse,
• transform

Transformations

• toCustom

Validations

• custom,
• maxSize,
• mimeType,
• minSize,
• notSize,
• size