@wgtechlabs/log-engine
Version:
A lightweight, security-first logging utility with automatic data redaction for Node.js applications - the first logging library with built-in PII protection.
41 lines • 1.73 kB
TypeScript
/**
* Shared test utilities for log-engine tests
* Provides consistent console mocking and cleanup functionality across all test suites
*/
/**
* Interface for managing console method mocks during testing
* Groups all console spy instances for easy setup and cleanup
*/
export interface ConsoleMocks {
/** Mock for console.log (used by debug and info methods) */
mockConsoleLog: jest.SpyInstance;
/** Mock for console.warn (used by warn method) */
mockConsoleWarn: jest.SpyInstance;
/** Mock for console.error (used by error method) */
mockConsoleError: jest.SpyInstance;
}
/**
* Sets up console mocks for testing log output
* Replaces console methods with Jest spies to capture and verify log calls
* @returns ConsoleMocks object containing all spy instances
*/
export declare const setupConsoleMocks: () => ConsoleMocks;
/**
* Restores console mocks after testing
* Cleans up Jest spies and restores original console functionality
* @param mocks - The ConsoleMocks object from setupConsoleMocks
*/
export declare const restoreConsoleMocks: (mocks: ConsoleMocks) => void;
/**
* Convenience function for setting up console mocks in beforeEach hooks
* Identical to setupConsoleMocks but with a more descriptive name for test setup
* @returns ConsoleMocks object containing all spy instances
*/
export declare const setupConsoleBeforeEach: () => ConsoleMocks;
/**
* Convenience function for restoring console mocks in afterEach hooks
* Identical to restoreConsoleMocks but with a more descriptive name for test cleanup
* @param mocks - The ConsoleMocks object to restore
*/
export declare const restoreConsoleAfterEach: (mocks: ConsoleMocks) => void;
//# sourceMappingURL=test-utils.d.ts.map