@envkit/nextjs
Version:
Environment variable management for Next.js applications
59 lines (58 loc) • 1.59 kB
TypeScript
/**
* Configuration options for EnvKit
*/
export interface EnvKitConfig {
/**
* List of required environment variables
*/
requiredVars: string[];
/**
* List of optional environment variables
*/
optionalVars?: string[];
/**
* Path to redirect to when environment variables are missing
* @default '/env-setup'
*/
fallbackPath?: string;
/**
* Force production mode behavior (stricter validation)
*/
isProduction?: boolean;
}
/**
* EnvKit client for environment variable management
*/
export declare class EnvKit {
private config;
/**
* Create a new EnvKit client
* @param config Configuration options
*/
constructor(config: EnvKitConfig);
/**
* Validate environment variables based on the current configuration
* @param env Environment variables to validate
* @returns Validation result with success flag and missing variables
*/
validateEnvironment(env: Record<string, string | undefined>): {
success: boolean;
data: any;
missingVars: string[];
};
/**
* Get the configuration for EnvKitProvider
* @returns Provider configuration object
*/
getProviderConfig(): {
requiredVars: string[];
fallbackPath: string | undefined;
isProduction: boolean | undefined;
};
}
/**
* Create a new EnvKit client with the specified configuration
* @param config Configuration options
* @returns EnvKit client instance
*/
export declare function createEnvKit(config: EnvKitConfig): EnvKit;