leylines/browser

Constants

logger

Side-effect-free singleton browser logger. Call logger.connect before entries are sent.

export const logger: BrowserLoggerSingleton;

^{🔍 logger on GitHub}

Types

BrowserLogger

Browser logger API used by application code.

export interface BrowserLogger {
  debug(scope: string, message: string, properties?: JsonObject): void;
  info(scope: string, message: string, properties?: JsonObject): void;
  warn(scope: string, message: string, properties?: JsonObject): void;
  error(scope: string, message: string, properties?: JsonObject, error?: unknown): void;
  write(level: LogLevel, scope: string, message: string, properties?: JsonObject, error?: unknown): void;
}

Properties

• debug Write a debug entry for a dotted domain scope.

• info Write an info entry for a dotted domain scope.

• warn Write a warning entry for a dotted domain scope.

• error Write an error entry for a dotted domain scope, optionally with normalized error details.

• write Write an entry at an explicit level for a dotted domain scope.

^{🔍 BrowserLogger on GitHub}

BrowserLoggerConnectOptions

Options for connecting the singleton browser logger.

export interface BrowserLoggerConnectOptions extends BrowserLoggerOptions {
  captureConsole?: boolean | LogLevel[];
  captureErrors?: boolean;
  captureRejections?: boolean;
}

Properties

• captureConsole Capture console methods. true captures all levels; an array captures selected levels.

• captureErrors Capture uncaught browser errors. Defaults to true.

• captureRejections Capture unhandled promise rejections. Defaults to true.

^{🔍 BrowserLoggerConnectOptions on GitHub}

BrowserLoggerOptions

Transport and inherited context for the browser logger.

export interface BrowserLoggerOptions {
  endpoint: string;
  scope?: string;
  metadata?: JsonObject;
  properties?: JsonObject;
  fetch?: typeof fetch;
}

Properties

• endpoint Local ingestion endpoint that receives JSON log entries.

• scope Root scope for entries. Defaults to browser.

• metadata Metadata inherited by every browser entry.

• properties Structured properties inherited by every browser entry.

• fetch Fetch implementation to use. Defaults to global fetch.

^{🔍 BrowserLoggerOptions on GitHub}

BrowserLoggerSingleton

Singleton browser logger that can be connected to a runtime ingestion endpoint.

export interface BrowserLoggerSingleton extends BrowserLogger {
  connect(options: BrowserLoggerConnectOptions): BrowserLoggerSingleton;
}

Properties

• connect Connect or reconfigure the singleton logger and optional browser capture hooks.

^{🔍 BrowserLoggerSingleton on GitHub}