@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

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

🔎 Check out the API Docs

How to use?

Import and enable the plugin:

1import * as d from 'doubter';
2import '@doubter/plugin-string-format';
3
4const emailShape = d.string().email();
5
6emailShape.parse('foo@bar.com');
7// ⮕ 'foo@bar.com'
8
9emailShape.parse('foo');
10// ❌ ValidationError: string.format.email at /: Must be an email

Or cherry-pick separate format checkers:

1import * as d from 'doubter';
2// 🟡 Import a single format module
3import '@doubter/plugin-string-format/bic';
4
5const bicShape = d.string().bic();
6
7bicShape.parse('BOFAUS3N');
8// ⮕ 'BOFAUS3N'
9
10bicShape.parse('QUX');
11// ❌ ValidationError: string.format.bic at /: Must be a BIC or SWIFT code

Validation issues

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

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

The code above would return an Err result:

1{
2  ok: false,
3  issues: [
4    {
5      code: 'string.format.email',
6      input: 'foo',
7      message: 'Must be an email',
8      param: {
9        allowDisplayName: false,
10        allowIPDomain: false,
11        allowUTF8LocalPart: true,
12        blacklistedChars: '',
13        hostBlacklist: [],
14        hostWhitelist: [],
15        ignoreMaxLength: false,
16        requireDisplayName: false,
17        requireTLD: true
18      }
19    }
20  ]
21}

Localization

Provide messages option to parsing methods:

1const emailShape = d.string().email();
2
3emailShape.parse('foo', {
4  messages: {
5    'string.format.email': 'Invalid email'
6  }
7});
8// ❌ ValidationError: string.format.email at /: Invalid email

Or pass a message directly to a plugin method:

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

More details in the Localization section of Doubter docs.