special

Creates a special schema.

This schema function allows you to define a schema that matches a value based on a custom function. Use it whenever you need to define a schema that cannot be expressed using any of the other schema functions.

// Special schema with an optional pipe
const Schema = special<TInput>(check, pipe);

// Special schema with an optional message and pipe
const Schema = special<TInput>(check, message, pipe);

Generics

• TInput extends any

Parameters

• check (input: unknown) => boolean
• message ErrorMessage | undefined
• pipe Pipe<TInput> | undefined

Explanation

With special you can validate the data type of the input and with pipe you can transform and validate the further details of the input. If the input does not match the validation of check, you can use message to customize the error message.

Make sure that the validation in check matches the data type of TInput.

Returns

• Schema SpecialSchema<TInput>

Examples

The following examples show how special can be used.

Pixel string schema

Schema to validate a pixel string.

const PixelStringSchema = special<`${number}px`>((val) =>
  typeof val === 'string' ? /^\d+px$/.test(val) : false
);

Related

The following APIs can be combined with special.

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,
• toLowerCase,
• toMaxValue,
• toMinValue,
• toTrimmed,
• toTrimmedEnd,
• toTrimmedStart,
• toUpperCase

Validations

• bic,
• bytes,
• creditCard,
• cuid2,
• custom,
• decimal,
• email,
• emoji,
• endsWith,
• every,
• excludes,
• finite,
• hash,
• hexadecimal,
• hexColor,
• imei,
• includes,
• integer,
• ip,
• ipv4,
• ipv6,
• isoDate,
• isoDateTime,
• isoTime,
• isoTimeSecond,
• isoTimestamp,
• isoWeek,
• length,
• mac,
• mac48,
• mac64,
• maxBytes,
• maxLength,
• maxSize,
• maxValue,
• mimeType,
• minBytes,
• minLength,
• minSize,
• minValue,
• multipleOf,
• notBytes,
• notLength,
• notSize,
• notValue,
• octal,
• regex,
• safeInteger,
• size,
• some,
• startsWith,
• ulid,
• url,
• uuid,
• value