UNPKG

project-setup-validation-yaml

Version:

Validate environment variables, files and directories. Supports YAML configuration

45 lines (42 loc) 1.4 kB
import { ValidatorSpec, bool, cleanEnv, email, host, json, num, port, str, url } from "envalid"; /** * Validation types, default + custom */ export declare const envalidValidationTypes: { readonly str: typeof str; readonly email: typeof email; readonly json: typeof json; readonly bool: typeof bool; readonly host: typeof host; readonly num: typeof num; readonly port: typeof port; readonly url: typeof url; readonly base64String: (spec?: import("envalid").Spec<string> | undefined) => ValidatorSpec<string>; readonly base64Json: (spec?: import("envalid").Spec<any> | undefined) => ValidatorSpec<any>; }; interface ICustomEnvValidators { base64JsonValidator: () => ValidatorSpec<any>; base64StringValidator: () => ValidatorSpec<any>; } /** * Custom validators */ export declare const customEnvValidators: ICustomEnvValidators; /** * Validates and returns clean env * * Example: * ``` import { str, json } from 'envalid' import {validateProjectEnvironment, customValidators} from './src/validators' validateProjectEnvironment(process.env, { FIREBASE_CREDENTIALS_BASE64: customValidators.base64JsonValidator(), TEST_STRING_ENV: str(), TEST_JSON_ENV: json() }) ``` Read more: https://www.npmjs.com/package/envalid */ export declare const validateProjectEnvironment: typeof cleanEnv; export {};