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

ConsoleLogger.md

160 lines2.8 KB

1---
2id: ConsoleLogger
3title: ConsoleLogger
4---
5​
6# Class: ConsoleLogger
7​
8Defined in: [packages/ai/src/logger/console-logger.ts:101](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L101)
9​
10Default `Logger` implementation that routes each level to the matching
11`console` method:
12​
13- `debug` → `console.debug`
14- `info` → `console.info`
15- `warn` → `console.warn`
16- `error` → `console.error`
17​
18When a `meta` object is supplied it is rendered with the strategy that
19actually surfaces it on the current runtime (see MetaStrategy):
20depth-unlimited `console.dir` on Node, circular-safe JSON on Cloudflare
21Workers, and an extra console argument everywhere else.
22​
23This is the logger used when `debug` is enabled on any activity and no
24custom `logger` is supplied via `debug: { logger }`.
25​
26## Implements
27​
28- [`Logger`](../interfaces/Logger.md)
29​
30## Constructors
31​
32### Constructor
33​
34```ts
35new ConsoleLogger(): ConsoleLogger;
36```
37​
38#### Returns
39​
40`ConsoleLogger`
41​
42## Methods
43​
44### debug()
45​
46```ts
47debug(message, meta?): void;
48```
49​
50Defined in: [packages/ai/src/logger/console-logger.ts:103](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L103)
51​
52Log a debug-level message; forwards to `console.debug`.
53​
54#### Parameters
55​
56##### message
57​
58`string`
59​
60##### meta?
61​
62`Record`\<`string`, `unknown`\>
63​
64#### Returns
65​
66`void`
67​
68#### Implementation of
69​
70[`Logger`](../interfaces/Logger.md).[`debug`](../interfaces/Logger.md#debug)
71​
72***
73​
74### error()
75​
76```ts
77error(message, meta?): void;
78```
79​
80Defined in: [packages/ai/src/logger/console-logger.ts:118](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L118)
81​
82Log an error-level message; forwards to `console.error`.
83​
84#### Parameters
85​
86##### message
87​
88`string`
89​
90##### meta?
91​
92`Record`\<`string`, `unknown`\>
93​
94#### Returns
95​
96`void`
97​
98#### Implementation of
99​
100[`Logger`](../interfaces/Logger.md).[`error`](../interfaces/Logger.md#error)
101​
102***
103​
104### info()
105​
106```ts
107info(message, meta?): void;
108```
109​
110Defined in: [packages/ai/src/logger/console-logger.ts:108](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L108)
111​
112Log an info-level message; forwards to `console.info`.
113​
114#### Parameters
115​
116##### message
117​
118`string`
119​
120##### meta?
121​
122`Record`\<`string`, `unknown`\>
123​
124#### Returns
125​
126`void`
127​
128#### Implementation of
129​
130[`Logger`](../interfaces/Logger.md).[`info`](../interfaces/Logger.md#info)
131​
132***
133​
134### warn()
135​
136```ts
137warn(message, meta?): void;
138```
139​
140Defined in: [packages/ai/src/logger/console-logger.ts:113](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L113)
141​
142Log a warning-level message; forwards to `console.warn`.
143​
144#### Parameters
145​
146##### message
147​
148`string`
149​
150##### meta?
151​
152`Record`\<`string`, `unknown`\>
153​
154#### Returns
155​
156`void`
157​
158#### Implementation of
159​
160[`Logger`](../interfaces/Logger.md).[`warn`](../interfaces/Logger.md#warn)