Skip to content

Latest commit

 

History

History
122 lines (67 loc) · 2.9 KB

File metadata and controls

122 lines (67 loc) · 2.9 KB
id Logger
title Logger

Interface: Logger

Defined in: packages/typescript/ai/src/logger/types.ts:4

Pluggable logger interface consumed by every @tanstack/ai activity when debug is enabled. Supply a custom implementation via debug: { logger } on chat(), summarize(), generateImage(), etc. The four methods correspond to log levels: use debug for chunk-level diagnostic output, info/warn for notable events, error for caught exceptions.

Properties

debug()

debug: (message, meta?) => void;

Defined in: packages/typescript/ai/src/logger/types.ts:9

Called for chunk-level diagnostic output (raw provider chunks, per-chunk output, agent-loop iteration markers).

Parameters

message

string

meta?

Record<string, unknown>

Structured data forwarded to the underlying logger. Loggers like pino will preserve this as a structured record; console-based loggers pass it as the second argument to console.<level>.

Returns

void


error()

error: (message, meta?) => void;

Defined in: packages/typescript/ai/src/logger/types.ts:24

Called for caught exceptions throughout the pipeline.

Parameters

message

string

meta?

Record<string, unknown>

Structured data forwarded to the underlying logger. Loggers like pino will preserve this as a structured record; console-based loggers pass it as the second argument to console.<level>.

Returns

void


info()

info: (message, meta?) => void;

Defined in: packages/typescript/ai/src/logger/types.ts:14

Called for notable informational events (outgoing requests, tool invocations, middleware transitions).

Parameters

message

string

meta?

Record<string, unknown>

Structured data forwarded to the underlying logger. Loggers like pino will preserve this as a structured record; console-based loggers pass it as the second argument to console.<level>.

Returns

void


warn()

warn: (message, meta?) => void;

Defined in: packages/typescript/ai/src/logger/types.ts:19

Called for notable warnings that don't halt execution (deprecations, recoverable anomalies).

Parameters

message

string

meta?

Record<string, unknown>

Structured data forwarded to the underlying logger. Loggers like pino will preserve this as a structured record; console-based loggers pass it as the second argument to console.<level>.

Returns

void