octal

Creates a pipeline validation action that validates an octal.

const Validation = octal<TInput>(message);

Generics

• TInput extends string

Parameters

• message ErrorMessage | undefined

Explanation

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

Returns

• Validation OctalValidation<TInput>

Examples

The following examples show how octal can be used.

Octal schema

Schema to validate a octal string.

const OctalSchema = string([octal('The octal is badly formatted.')]);

Related

The following APIs can be combined with octal.

Schemas

• any,
• special,
• string,
• unknown