hash

Creates a pipeline validation action that validates a hash.

const Validation = hash<TInput>(message);

Generics

• TInput extends string

Parameters

• types [HashType, ...HashType[]]

• message ErrorMessage | undefined

Explanation

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

Returns

• Validation HashValidation<TInput>

Examples

The following examples show how hash can be used.

Hash schema

Schema to validate a hash.

const HashSchema = string([
  hash(['md5', 'sha1'], 'The specified hash is invalid.'),
]);

Related

The following APIs can be combined with hash.

Schemas

• any,
• special,
• string,
• unknown