zod-config/dist/types-4fcc40ec.d.ts

Load configuration variables from multiple sources with flexible adapters, ensuring type safety with Zod.

import { z } from 'zod';

/**
 * Adapter type
 */
type Adapter<T extends z.AnyZodObject = z.AnyZodObject> = {
    /**
     * Name of the adapter
     */
    name: string;
    /**
     * Read the config
     */
    read: () => Promise<z.infer<T>>;
    /**
     * Whether to suppress errors
     */
    silent?: boolean;
};
/**
 * Config type
 */
type Config<T extends z.AnyZodObject = z.AnyZodObject> = {
    /**
     * Schema to validate the config against
     */
    schema: T;
    /**
     * Adapters to use
     */
    adapters?: Adapter[] | Adapter;
    /**
     * Function to call on success
     */
    onSuccess?: (data: z.infer<T>) => void;
    /**
     * Function to call on error
     */
    onError?: (error: z.ZodError<z.infer<T>>) => void;
    /**
     * Logger to use
     */
    logger?: Logger;
};
/**
 * Logger type
 */
type Logger = {
    /**
     * Log a warning
     */
    warn: (message: string) => void;
};
/**
 * Base adapter props
 */
type BaseAdapterProps = {
    /**
     * Prefix key to filter keys by
     * @deprecated Use regex instead
     */
    prefixKey?: string;
    /**
     * Regular expression to filter keys by: if used, prefixKey will be ignored
     */
    regex?: RegExp;
    /**
     * Whether to suppress errors
     */
    silent?: boolean;
};

export { Adapter as A, BaseAdapterProps as B, Config as C, Logger as L };