Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

ConsoleLogger.md

146 lines2.7 KB

1---
2id: ConsoleLogger
3title: ConsoleLogger
4---
5​
6# Class: ConsoleLogger
7​
8Defined in: [packages/typescript/ai/src/logger/console-logger.ts:25](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/logger/console-logger.ts#L25)
9​
10Pluggable 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.
11​
12## Implements
13​
14- [`Logger`](../interfaces/Logger.md)
15​
16## Constructors
17​
18### Constructor
19​
20```ts
21new ConsoleLogger(): ConsoleLogger;
22```
23​
24#### Returns
25​
26`ConsoleLogger`
27​
28## Methods
29​
30### debug()
31​
32```ts
33debug(message, meta?): void;
34```
35​
36Defined in: [packages/typescript/ai/src/logger/console-logger.ts:27](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/logger/console-logger.ts#L27)
37​
38Log a debug-level message; forwards to `console.debug`.
39​
40#### Parameters
41​
42##### message
43​
44`string`
45​
46##### meta?
47​
48`Record`\<`string`, `unknown`\>
49​
50#### Returns
51​
52`void`
53​
54#### Implementation of
55​
56[`Logger`](../interfaces/Logger.md).[`debug`](../interfaces/Logger.md#debug)
57​
58***
59​
60### error()
61​
62```ts
63error(message, meta?): void;
64```
65​
66Defined in: [packages/typescript/ai/src/logger/console-logger.ts:45](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/logger/console-logger.ts#L45)
67​
68Log an error-level message; forwards to `console.error`.
69​
70#### Parameters
71​
72##### message
73​
74`string`
75​
76##### meta?
77​
78`Record`\<`string`, `unknown`\>
79​
80#### Returns
81​
82`void`
83​
84#### Implementation of
85​
86[`Logger`](../interfaces/Logger.md).[`error`](../interfaces/Logger.md#error)
87​
88***
89​
90### info()
91​
92```ts
93info(message, meta?): void;
94```
95​
96Defined in: [packages/typescript/ai/src/logger/console-logger.ts:33](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/logger/console-logger.ts#L33)
97​
98Log an info-level message; forwards to `console.info`.
99​
100#### Parameters
101​
102##### message
103​
104`string`
105​
106##### meta?
107​
108`Record`\<`string`, `unknown`\>
109​
110#### Returns
111​
112`void`
113​
114#### Implementation of
115​
116[`Logger`](../interfaces/Logger.md).[`info`](../interfaces/Logger.md#info)
117​
118***
119​
120### warn()
121​
122```ts
123warn(message, meta?): void;
124```
125​
126Defined in: [packages/typescript/ai/src/logger/console-logger.ts:39](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/logger/console-logger.ts#L39)
127​
128Log a warning-level message; forwards to `console.warn`.
129​
130#### Parameters
131​
132##### message
133​
134`string`
135​
136##### meta?
137​
138`Record`\<`string`, `unknown`\>
139​
140#### Returns
141​
142`void`
143​
144#### Implementation of
145​
146[`Logger`](../interfaces/Logger.md).[`warn`](../interfaces/Logger.md#warn)