Skip to content

@statesync/core


@statesync/core / createConsoleLogger

Function: createConsoleLogger()

ts
function createConsoleLogger(options): Logger;

Defined in: logger.ts:68

Creates a Logger implementation backed by console.debug, console.warn, and console.error.

This is intentionally minimal DX sugar so users can get structured logs without wiring a full logging framework. Each log call prepends the configured prefix and passes the optional extra payload as a second argument to the console method.

Parameters

ParameterTypeDescription
optionsConsoleLoggerOptionsOptional configuration for prefix and debug verbosity. Defaults to prefix "[state-sync]" and debug disabled.

Returns

Logger

A Logger instance that delegates to the global console object.

Example

ts
import { createConsoleLogger } from '@statesync/core';

// Basic usage with defaults
const logger = createConsoleLogger();

// Custom prefix and debug enabled
const verboseLogger = createConsoleLogger({
  prefix: '[my-app/sync]',
  debug: true,
});

verboseLogger.debug('snapshot fetched', { revision: '42' });
// Console output: [my-app/sync] snapshot fetched { revision: '42' }

Released under the MIT License.