aboutsummaryrefslogtreecommitdiff
path: root/packages/bun-types/console.d.ts
blob: 08ca64c779af49002a4efd41f49154a6b664b1e7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/**
 * The `console` module provides a simple debugging console that is similar to the
 * JavaScript console mechanism provided by web browsers.
 *
 * The module exports two specific components:
 *
 * * A `Console` class with methods such as `console.log()`, `console.error()` and`console.warn()` that can be used to write to any Node.js stream.
 * * A global `console` instance configured to write to `process.stdout` and `process.stderr`. The global `console` can be used without calling`require('console')`.
 *
 * _**Warning**_: The global console object's methods are neither consistently
 * synchronous like the browser APIs they resemble, nor are they consistently
 * asynchronous like all other Node.js streams. See the `note on process I/O` for
 * more information.
 *
 * Example using the global `console`:
 *
 * ```js
 * console.log('hello world');
 * // Prints: hello world, to stdout
 * console.log('hello %s', 'world');
 * // Prints: hello world, to stdout
 * console.error(new Error('Whoops, something bad happened'));
 * // Prints error message and stack trace to stderr:
 * //   Error: Whoops, something bad happened
 * //     at [eval]:5:15
 * //     at Script.runInThisContext (node:vm:132:18)
 * //     at Object.runInThisContext (node:vm:309:38)
 * //     at node:internal/process/execution:77:19
 * //     at [eval]-wrapper:6:22
 * //     at evalScript (node:internal/process/execution:76:60)
 * //     at node:internal/main/eval_string:23:3
 *
 * const name = 'Will Robinson';
 * console.warn(`Danger ${name}! Danger!`);
 * // Prints: Danger Will Robinson! Danger!, to stderr
 * ```
 *
 * Example using the `Console` class:
 *
 * ```js
 * const out = getStreamSomehow();
 * const err = getStreamSomehow();
 * const myConsole = new console.Console(out, err);
 *
 * myConsole.log('hello world');
 * // Prints: hello world, to out
 * myConsole.log('hello %s', 'world');
 * // Prints: hello world, to out
 * myConsole.error(new Error('Whoops, something bad happened'));
 * // Prints: [Error: Whoops, something bad happened], to err
 *
 * const name = 'Will Robinson';
 * myConsole.warn(`Danger ${name}! Danger!`);
 * // Prints: Danger Will Robinson! Danger!, to err
 * ```
 * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/console.js)
 */
declare module "console" {
  import console = require("node:console");
  export = console;
}
declare module "node:console" {
  // import { InspectOptions } from "node:util";
  // global {

  /**
   * The `console` module provides a simple debugging console that is similar to the
   * JavaScript console mechanism provided by web browsers.
   *
   * The module exports two specific components:
   *
   * * A `Console` class with methods such as `console.log()`, `console.error()` and`console.warn()` that can be used to write to any Node.js stream.
   * * A global `console` instance configured to write to `process.stdout` and `process.stderr`. The global `console` can be used without calling`require('console')`.
   *
   * _**Warning**_: The global console object's methods are neither consistently
   * synchronous like the browser APIs they resemble, nor are they consistently
   * asynchronous like all other Node.js streams. See the `note on process I/O` for
   * more information.
   *
   * Example using the global `console`:
   *
   * ```js
   * console.log('hello world');
   * // Prints: hello world, to stdout
   * console.log('hello %s', 'world');
   * // Prints: hello world, to stdout
   * console.error(new Error('Whoops, something bad happened'));
   * // Prints error message and stack trace to stderr:
   * //   Error: Whoops, something bad happened
   * //     at [eval]:5:15
   * //     at Script.runInThisContext (node:vm:132:18)
   * //     at Object.runInThisContext (node:vm:309:38)
   * //     at node:internal/process/execution:77:19
   * //     at [eval]-wrapper:6:22
   * //     at evalScript (node:internal/process/execution:76:60)
   * //     at node:internal/main/eval_string:23:3
   *
   * const name = 'Will Robinson';
   * console.warn(`Danger ${name}! Danger!`);
   * // Prints: Danger Will Robinson! Danger!, to stderr
   * ```
   *
   * Example using the `Console` class:
   *
   * ```js
   * const out = getStreamSomehow();
   * const err = getStreamSomehow();
   * const myConsole = new console.Console(out, err);
   *
   * myConsole.log('hello world');
   * // Prints: hello world, to out
   * myConsole.log('hello %s', 'world');
   * // Prints: hello world, to out
   * myConsole.error(new Error('Whoops, something bad happened'));
   * // Prints: [Error: Whoops, something bad happened], to err
   *
   * const name = 'Will Robinson';
   * myConsole.warn(`Danger ${name}! Danger!`);
   * // Prints: Danger Will Robinson! Danger!, to err
   * ```
   * @see [source](https://github.com/nodejs/node/blob/v16.4.2/lib/console.js)
   */
  // import {Writable} from "node:stream";
  // namespace console {
  //   interface ConsoleConstructorOptions {
  //     stdout: Writable;
  //     stderr?: Writable | undefined;
  //     ignoreErrors?: boolean | undefined;
  //     colorMode?: boolean | "auto" | undefined;
  //     inspectOptions?: InspectOptions | undefined;
  //     /**
  //      * Set group indentation
  //      * @default 2
  //      */
  //     groupIndentation?: number | undefined;
  //   }
  //   interface ConsoleConstructor {
  //     prototype: Console;
  //     new (stdout: Writable, stderr?: Writable, ignoreErrors?: boolean): Console;
  //     new (options: ConsoleConstructorOptions): Console;
  //   }
  // }

  // }
  // const console: Console;

  export = console;
}