@stacksjs/stx
Version:
A performant UI Framework. Powered by Bun.
41 lines • 1.21 kB
TypeScript
import type { StxConfig, StxOptions } from './types';
export declare function loadStxConfig(): Promise<StxConfig>;
/**
* Helper function to define stx configuration
*/
export declare function defineStxConfig(config: StxOptions): StxOptions;
/**
* Validate stx configuration
*
* @param config - Configuration to validate
* @returns Validation result with errors and warnings
*
* @example
* ```typescript
* const result = validateConfig(myConfig)
* if (!result.valid) {
* console.error('Config errors:', result.errors)
* }
* ```
*/
export declare function validateConfig(config: StxOptions): ConfigValidationResult;
export declare const defaultConfig: StxConfig;
// Export a synchronous getter that returns defaults immediately, then loads async
// This allows the module to be imported instantly without blocking
export declare const config: StxConfig;
/**
* Configuration validation error
*/
export declare interface ConfigValidationError {
path: string
message: string
severity: 'error' | 'warning'
}
/**
* Configuration validation result
*/
export declare interface ConfigValidationResult {
valid: boolean
errors: ConfigValidationError[]
warnings: ConfigValidationError[]
}