const { createConsoleIQ } = require('consoleiq');

// Initialize with default options
const ConsoleIQ = createConsoleIQ();

// Use enhanced console methods
console.log('Regular log message');
console.info('Info message in blue');
console.warn('Warning message in yellow');
console.error('Error message in red');
console.debug('Debug message in green');

// Use custom text method (for remote logging)
console.text('This can be sent to a remote server if configured');

// When done, restore original console behavior
ConsoleIQ.restore();

Configuration

const { createConsoleIQ } = require('consoleiq');

const ConsoleIQ = createConsoleIQ({  
  // API key for authentication (optional)
  apiKey: 'your-api-key',
  
  // Enable/disable colorization (default: true)
  colorize: true,
  
  // Enable/disable console output (default: false)
  silent: false
});

Using with React

Basic Setup

// src/logger.js
import { createConsoleIQ } from 'consoleiq';

export const logger = createConsoleIQ({
  apiKey: process.env.REACT_APP_LOGGING_API_KEY
});

// src/index.js or App.js
import { logger } from './logger';

// Initialize logger early in your app
logger.init();

// Use in your components
function App() {
  useEffect(() => {
    console.info('App mounted');
    console.text('This will be sent to the server');
    
    // Cleanup on unmount
    return () => logger.restore();
  }, []);

  return <div>Your App</div>;
}

Custom Hook

// src/hooks/useLogger.js
import { useEffect } from 'react';
import { createConsoleIQ } from 'consoleIQ';

export function useLogger(config = {}) {
  useEffect(() => {
    const logger = createConsoleIQ(config);
    logger.init();
    
    return () => logger.restore();
  }, []);
}

// Usage in component
function MyComponent() {
  useLogger({
    colorize: true
  });

  return <div>Component with logging</div>;
}

Remote Logging

Only the console.text() method sends logs to the remote server. Other console methods are enhanced but only output locally.

// Configure with remote endpoint
const ConsoleIQ = createConsoleIQ({
  apiKey: 'your-api-key'
});

// This will be sent to the remote server
console.text('Important information to log remotely');

// These will only appear in the local console
console.log('Local log message');
console.info('Local info message');

Advanced Usage

Manual Initialization

const { ConsoleIQ } = require('consoleIQ');

// Create instance without auto-initialization
const logger = new ConsoleIQ({
  colorize: true,
});

// Initialize when ready
logger.init();

// Use enhanced console
console.log('Console is now enhanced');

// Restore when done
logger.restore();

API Reference

`createConsoleIQ(config)`

Creates and initializes a new ConsoleIQ instance.

config (Object): Configuration options
- endpoint (String): URL for remote logging
- apiKey (String): Authentication key for remote endpoint
- colorize (Boolean): Whether to colorize console output (default: true)
- silent (Boolean): Whether to suppress console output (default: false)

Returns an initialized ConsoleIQ instance.