@doubter/plugin-string-format

String format validation plugin for Doubter.

• ASCII
• BIC
• Email
• Fully qualified domain name
• IMEI number
• IP
• ISIN
• Luhn algorithm
• MIME type
• UUID

npm install --save-prod doubter @doubter/plugin-string-format

🔎 Check out the API Docs

How to use?

Import and enable the plugin:

import * as d from 'doubter';
import enableStringFormat from '@doubter/plugin-string-format';

enableStringFormat(d.StringShape);

const emailShape = d.string().email();

emailShape.parse('[email protected]');
// ⮕ '[email protected]'

emailShape.parse('foo');
// ❌ ValidationError: string.format at /: Must be an email

Cherry-pick separate format checkers:

import * as d from 'doubter';
// 🟡 Import a single format module
import enableBICFormat from '@doubter/plugin-string-format/bic';

enableBICFormat(d.StringShape);

const bicShape = d.string().bic();

bicShape.parse('BOFAUS3N');
// ⮕ 'BOFAUS3N'

bicShape.parse('QUX');
// ❌ ValidationError: string.format at /: Must be a BIC or SWIFT code

Validation issues

Format checks raise issues with "string.format" code.

d.string().email().try('foo');

The code above would return an Err result:

{
  ok: false,
  issues: [
    {
      code: 'string.format',
      input: 'foo',
      message: 'Must be an email',
      param: {
        format: 'email',
        allowDisplayName: false,
        allowIPDomain: false,
        allowUTF8LocalPart: true,
        blacklistedChars: '',
        hostBlacklist: [],
        hostWhitelist: [],
        ignoreMaxLength: false,
        requireDisplayName: false,
        requireTLD: true,
      },
    },
  ],
}

Use .issues[].param.format to detect the exact format that was violated.

Localization

The default issue messages used by this plugin can be globally configured through d.Shape.message:

d.Shape.message['string.format.email'] = 'Invalid email';

const emailShape = d.string().email();

emailShape.parse('foo');
// ❌ ValidationError: string.format at /: Invalid email

Or pass a message directly to a plugin method:

d.string().email('Not an email').parse('foo');
// ❌ ValidationError: string.format at /: Not an email