npm

convict-format-with-validator
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/convict-format-with-validator package

6.2.0 • Public • Published

Convict-format-with-validator

NPM version

Formats email, ipaddress and url for convict with validator.js.

Install

npm install convict-format-with-validator

Usage

An example config.js file:

const convict = require('convict');
const convict_format_with_validator = require('convict-format-with-validator');

// Add all formats
convict.addFormats(convict_format_with_validator);

// Or add only specific formats:
// convict.addFormat(convict_format_with_validator.ipaddress);
// etc.

// Define a schema
var config = convict({
  ip: {
    doc: 'The IP address to bind.',
    format: 'ipaddress',
    default: '127.0.0.1',
    env: 'IP_ADDRESS',
  },
  port: {
    doc: 'The port to bind.',
    format: 'port',
    default: 8080,
    env: 'PORT',
    arg: 'port'
  }
});

Validation

Validation done through validator.js:

  • email
  • ipaddress - IPv4 and IPv6 addresses
  • url

Coercion

Convict will automatically coerce environmental variables from strings to their proper types when importing them.

Package Sidebar

Install

npm i convict-format-with-validator

Weekly Downloads

56,382

Version

6.2.0

License

Apache-2.0

Unpacked Size

3.48 kB

Total Files

4

Last publish

Collaborators

  • vladikoff
  • dannycoates
  • madarche
  • rfkelly