@adonisjs/env/build/src/validator.d.ts

Environment variable manager for Node.js

import type { ValidateFn } from '@poppinss/validator-lite/types';
/**
 * Exposes the API to validate environment variables against a
 * pre-defined schema.
 *
 * The class is not exported in the main API and used internally.
 */
export declare class EnvValidator<Schema extends {
    [key: string]: ValidateFn<unknown>;
}> {
    #private;
    /**
     * Creates a new EnvValidator instance
     *
     * @param schema - The validation schema object
     */
    constructor(schema: Schema);
    /**
     * Accepts an object of values to validate against the pre-defined
     * schema.
     *
     * The return value is a merged copy of the original object and the
     * values mutated by the schema validator.
     *
     * @param values - Object of environment variable values to validate
     * @returns Validated and transformed environment variables
     */
    validate(values: {
        [K: string]: string | undefined;
    }): {
        [K in keyof Schema]: ReturnType<Schema[K]>;
    };
}