Nihilism Philisophy Major

    @nidomiro/config-helper
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.0 • Public • Published

    @nidomiro/config-helper

    npm (scoped) GitHub branch checks state

    This library makes it easy to create configurable apps in TypeScript. As you may already know configuration is a key aspect of a Twelve-Factor App.

    If you use this library you only need to define the configuration schema once and get a correctly typed configuration object or an error containing all the made configurations that violate the schema.

    The library was inspired by node-convict but rewritten in TypeScript and with some useful extra features.

    Feature overview

    • Fully typed configuration
    • Input validation
    • Automatic env-var mapping
    • Support for *_FILE env-vars
    • Does not throw Errors if not mentioned explicitly (getProperties vs getPropertiesOrThrow)
    • Very extendable

    Installation

    npm

    npm install @nidomiro/config-helper

    yarn

    yarn add @nidomiro/config-helper

    Quick Start

    To start execute createConfig and store it's return value in a variable. The first parameter represents the configuration schema. Here you define what parameters you want to have and how they are converted and validated.

    If you don't want to supply the value directly via an env-var, you can make use of *_FILE-env-vars. In the example below you could provide the env-var DATABASE_PASSWORD_FILE with the path to a file instead of the env-var DATABASE_PASSWORD. The whole content of the given file is then used as value.

    Config resolution order:

    1. Environment variable in the following order:
      1. envVar, auto-generated or explicit
      2. altEnvVars, leftmost will match first
    2. File environment variables (schema: ${envVar}_FILE) in the following order:
      1. ${envVar}_FILE, auto-generated or explicit
      2. ${altEnvVars[x]}_FILE, leftmost will match first
    3. Default value

    Keep in mind: If any error happens while reading the file, this library will not attempt to read an altEnvVars file instead.

    Example: (If you want more examples, head over to config-helper-e2e)

    import { booleanParam, createConfig, numberParam, regexParam, stringParam, enumParam } from '@nidomiro/config-helper'
    
    export const config = createConfig({
    	env: enumParam({
    		defaultValue: 'production',
    		possibleValues: ['production', 'development'],
    		envVar: 'NODE_ENV' /* This won't be overwritten by default */,
    	}),
    	port: numberParam({ defaultValue: 8080 }), // Will be configurable via env-var 'PORT'
    	database: {
    		connectionUrl: stringParam({
    			defaultValue: 'dbms://my-db-server.example.org',
    			matches: /^dbms:\/\/[\w-]+(:?\.[\w-]+)*$/,
    		}), // Will be configurable via env-var 'DATABASE_CONNECTION_URL' and checked if it matches the given regex
    		username: stringParam({ defaultValue: null }), // Will be configurable via env-var 'DATABASE_USERNAME' and will return an error if it wasn't set
    		password: stringParam({ defaultValue: null }), // Will be configurable via env-var 'DATABASE_PASSWORD' and will return an error if it wasn't set
    	},
    	someOptionalProp: stringParam({ defaultValue: null, optional: true }), // Will be configurable via env-var 'SOME_OPTIONAL_PROP' and can be null
    	enableFeatureX: booleanParam({ defaultValue: false }), // Will be configurable via env-var 'ENABLE_FEATURE_X'
    	nameValidationRegex: regexParam({ defaultValue: /\w+/ }), // Will be configurable via env-var 'NAME_VALIDATION_REGEX' and checked if it is a valid regex
    })
    
    const propertiesResult = config.getProperties() // contains either the properties or a list of errors (uses neverthrow's Result)
    if (propertiesResult.isErr()) {
    	// Not the best error handling, but it showcases that you'll get a list with all errors
    	throw new Error(`Configuration-errors occurred: ${propertiesResult.error.map(schemaErrorToString).toString()}`)
    }
    
    // If you do not plan to use the error for further logic you can call getPropertiesOrThrow() instead
    // const properties = config.getPropertiesOrThrow()
    
    const properties = propertiesResult.value
    properties.database.connectionUrl // Access the properties as you would expect; type: string
    properties.someOptionalProp // type: string | null

    Available param types

    • numberParam({ defaultValue: 0 }): requires a number
    • stringParam({ defaultValue: '' }): requires a string that optionally matches a regex with option matches
    • booleanParam({ defaultValue: false }): requires a boolean
    • regexParam({ defaultValue: '' }): requires a Regular Expression
    • emumParam({ defaultValue: 'a', possibleValues: ['a', 'b'] }): requires a value that is either 'a' or 'b'
    • param( {defaultValue: T, transformer: (val: unknown):T => {...} }): a generic parameter where you can define the parameter type yourself

    Custom predefined params

    If you want to create a custom param you can use the function paramUnsafe inside your function definition. paramUnsafe is not unsafe to execute, but TypeScript cannot infer the types correctly if used in a config-schema. To help TypeScript with type inference this method is wrapped.

    To create your custom parameter use numberParam as a guideline: ./src/lib/params/number-param.ts

    Config options

    This library provides some additional options to customize:

    const options: ConfigOptions = {
    	/**
    	 * Adds MY_PREFIX as prefix of every generated env.
    	 * In the example above the config 'port' would be configurable via 'MY_PREFIX_PORT'.
    	 * default: no prefix
    	 */
    	envPrefix: 'MY_PREFIX_',
    	/**
    	 * Apply the envPrefix to existing env entries if true.
    	 * In the example above the config 'env' would be 'MY_PREFIX_NODE_ENV'
    	 * default: false
    	 */
    	prefixExistingEnv: true,
    	/**
    	 * Override the used environment eg. in tests
    	 *
    	 * default: process.env
    	 */
    	env: {...},
    
    	/**
    	 * A list of loaders to be used to resolve the config-value.
    	 * The list is read from front to back, and the first match will be used as value.
    	 *
    	 * default: [envVarLoader, fileEnvVarLoader, defaultLoader]
    	 */
    	valueLoaders: [envVarLoader, fileEnvVarLoader, defaultLoader]
    }

    Install

    npm i @nidomiro/config-helper

    DownloadsWeekly Downloads

    55

    Version

    1.2.0

    License

    MIT

    Unpacked Size

    74 kB

    Total Files

    105

    Last publish

    Collaborators

    • nidomiro