@types/convict

What is @types/convict?

@types/convict provides TypeScript type definitions for the convict configuration management library. Convict helps manage configuration files in Node.js applications by defining a schema for configuration, validating it, and providing default values.

What are @types/convict's main functionalities?

Define Configuration Schema

This feature allows you to define a schema for your configuration, specifying the format, default values, and environment variables.

const convict = require('convict');

const config = convict({
  env: {
    doc: 'The application environment.',
    format: ['production', 'development', 'test'],
    default: 'development',
    env: 'NODE_ENV'
  },
  port: {
    doc: 'The port to bind.',
    format: 'port',
    default: 8080,
    env: 'PORT'
  }
});

Load Configuration from Files

You can load configuration values from JSON files based on the environment, making it easy to manage different configurations for different environments.

config.loadFile('./config/' + config.get('env') + '.json');

Validate Configuration

Convict can validate the configuration against the schema, ensuring that all required fields are present and have the correct format.

config.validate({ allowed: 'strict' });

Get Configuration Values

You can easily retrieve configuration values using the `get` method.

const port = config.get('port');

Other packages similar to @types/convict

config

The 'config' package provides a similar way to manage configuration files in Node.js applications. It supports multiple configuration files for different environments and allows for hierarchical configurations. Unlike convict, it does not enforce a schema or validation.

dotenv

The 'dotenv' package loads environment variables from a .env file into process.env. It is simpler than convict and does not provide schema validation or hierarchical configuration, but it is very useful for managing environment variables in development.

nconf

The 'nconf' package is a hierarchical configuration manager for Node.js. It supports multiple configuration sources such as command-line arguments, environment variables, and configuration files. Unlike convict, it does not enforce a schema but provides more flexibility in configuration sources.

README

Installation

npm install --save @types/convict

Summary

This package contains type definitions for convict (https://github.com/mozilla/node-convict).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/convict.

Additional Details

• Last updated: Mon, 06 Nov 2023 22:41:05 GMT
• Dependencies: @types/node

Credits

These definitions were written by Wim Looman, Vesa Poikajärvi, Eli Young, Suntharesan Mohan, Igor Strebezhev, and Peter Somogyvari.