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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
|
# Console
GJS implements the [WHATWG Console][whatwg-console] specification, with some
changes to accommodate GLib.
In particular, log severity is mapped to [`GLib.LogLevelFlags`][gloglevelflags]
and some methods are not implemented:
* `console.profile()`
* `console.profileEnd()`
* `console.timeStamp()`
#### Import
The functions in this module are available globally, without import.
[whatwg-console]: https://console.spec.whatwg.org/
[gloglevelflags]: https://gjs-docs.gnome.org/glib20/glib.loglevelflags
### console.assert(condition, ...data)
Type:
* Static
Parameters:
* condition (`Boolean`) — A boolean condition which, if `false`, causes the log
to print
* data (`Any`) — Formatting substitutions, if applicable
> New in GJS 1.70 (GNOME 41)
Logs a critical message if the condition is not truthy.
See [`console.error()`](#console-error) for additional information.
### console.clear()
Type:
* Static
> New in GJS 1.70 (GNOME 41)
Resets grouping and clears the terminal on systems supporting ANSI terminal
control sequences.
In file-based stdout or systems which do not support clearing, `console.clear()`
has no visual effect.
### console.count(label)
Type:
* Static
Parameters:
* label (`String`) — Optional label
> New in GJS 1.70 (GNOME 41)
Logs how many times `console.count()` has been called with the given `label`.
See [`console.countReset()`](#console-countreset) for resetting a count.
### console.countReset(label)
Type:
* Static
Parameters:
* label (`String`) — The unique label to reset the count for
> New in GJS 1.70 (GNOME 41)
Resets a counter used with `console.count()`.
### console.debug(...data)
Type:
* Static
Parameters:
* data (`Any`) — Formatting substitutions, if applicable
> New in GJS 1.70 (GNOME 41)
Logs a message with severity equal to
[`GLib.LogLevelFlags.LEVEL_DEBUG`][gloglevelflagsdebug].
[gloglevelflagsdebug]: https://gjs-docs.gnome.org/glib20/glib.loglevelflags#default-level_debug
### console.dir(item, options)
Type:
* Static
Parameters:
* item (`Object`) — The item to display
* options (`undefined`) — Additional options for the formatter. Unused in GJS.
> New in GJS 1.70 (GNOME 41)
Resurively display all properties of `item`.
### console.dirxml(...data)
Type:
* Static
Parameters:
* data (`Any`) — Formatting substitutions, if applicable
> New in GJS 1.70 (GNOME 41)
Alias for [`console.log()`](#console-log)
### console.error(...data)
Type:
* Static
Parameters:
* data (`Any`) — Formatting substitutions, if applicable
> New in GJS 1.70 (GNOME 41)
Logs a message with severity equal to
[`GLib.LogLevelFlags.LEVEL_CRITICAL`][gloglevelflagscritical].
Does not use [`GLib.LogLevelFlags.LEVEL_ERROR`][gloglevelflagserror] to avoid
asserting and forcibly shutting down the application.
[gloglevelflagscritical]: https://gjs-docs.gnome.org/glib20/glib.loglevelflags#default-level_critical
[gloglevelflagserror]: https://gjs-docs.gnome.org/glib20/glib.loglevelflags#default-level_error
### console.group(...data)
Type:
* Static
Parameters:
* data (`Any`) — Formatting substitutions, if applicable
> New in GJS 1.70 (GNOME 41)
Creates a new inline group in the console log, causing any subsequent console
messages to be indented by an additional level, until `console.groupEnd()` is
called.
### console.groupCollapsed(...data)
Type:
* Static
Parameters:
* data (`Any`) — Formatting substitutions, if applicable
> New in GJS 1.70 (GNOME 41)
Alias for [`console.group()`](#console-group)
### console.groupEnd()
Type:
* Static
> New in GJS 1.70 (GNOME 41)
Exits the current inline group in the console log.
### console.info(...data)
Type:
* Static
Parameters:
* data (`Any`) — Formatting substitutions, if applicable
> New in GJS 1.70 (GNOME 41)
Logs a message with severity equal to
[`GLib.LogLevelFlags.LEVEL_INFO`][gloglevelflagsinfo].
[gloglevelflagsinfo]: https://gjs-docs.gnome.org/glib20/glib.loglevelflags#default-level_info
### console.log(...data)
Type:
* Static
Parameters:
* data (`Any`) — Formatting substitutions, if applicable
> New in GJS 1.70 (GNOME 41)
Logs a message with severity equal to
[`GLib.LogLevelFlags.LEVEL_MESSAGE`][gloglevelflagsmessage].
[gloglevelflagsmessage]: https://gjs-docs.gnome.org/glib20/glib.loglevelflags#default-level_message
### console.table(tabularData, options)
> Note: This is an alias for [`console.log()`](#console-log) in GJS
Type:
* Static
Parameters:
* tabularData (`Any`) — Formatting substitutions, if applicable
* properties (`undefined`) — Unsupported in GJS
> New in GJS 1.70 (GNOME 41)
Logs a message with severity equal to
[`GLib.LogLevelFlags.LEVEL_MESSAGE`][gloglevelflagsmessage].
[gloglevelflagsmessage]: https://gjs-docs.gnome.org/glib20/glib.loglevelflags#default-level_message
### console.time(label)
Type:
* Static
Parameters:
* label (`String`) — unique identifier for this action, pass to
`console.timeEnd()` to complete
> New in GJS 1.70 (GNOME 41)
Starts a timer you can use to track how long an operation takes.
### console.timeEnd(label)
Type:
* Static
Parameters:
* label (`String`) — unique identifier for this action
> New in GJS 1.70 (GNOME 41)
Logs the time since the last call to `console.time(label)` and completes the
action.
Call `console.time(label)` again to re-measure.
### console.timeLog(label, ...data)
Type:
* Static
Parameters:
* label (`String`) — unique identifier for this action, pass to
`console.timeEnd()` to complete
* data (`Any`) — Formatting substitutions, if applicable
> New in GJS 1.70 (GNOME 41)
Logs the time since the last call to `console.time(label)` where `label` is the
same.
### console.trace(...data)
Type:
* Static
Parameters:
* data (`Any`) — Formatting substitutions, if applicable
> New in GJS 1.70 (GNOME 41)
Outputs a stack trace to the console.
### console.warn(...data)
Type:
* Static
Parameters:
* data (`Any`) — Formatting substitutions, if applicable
> New in GJS 1.70 (GNOME 41)
Logs a message with severity equal to
[`GLib.LogLevelFlags.LEVEL_WARNING`][gloglevelflagswarning].
[gloglevelflagswarning]: https://gjs-docs.gnome.org/glib20/glib.loglevelflags#default-level_warning
## Log Domain
> New in GJS 1.70 (GNOME 41)
The log domain for the default global `console` object is set to `"Gjs-Console"`
by default, but can be changed if necessary. The three symbols of interest are
`setConsoleLogDomain()`, `getConsoleLogDomain()` and `DEFAULT_LOG_DOMAIN`.
You can import these symbols and modify the log domain like so:
```js
import { setConsoleLogDomain, getConsoleLogDomain, DEFAULT_LOG_DOMAIN } from 'console';
// Setting the log domain
setConsoleLogDomain('my.app.id');
// expected output: my.app.id-Message: 12:21:17.899: cool
console.log('cool');
// Checking and resetting the log domain
if (getConsoleLogDomain() !== DEFAULT_LOG_DOMAIN)
setConsoleLogDomain(DEFAULT_LOG_DOMAIN);
// expected output: Gjs-Console-Message: 12:21:17.899: cool
console.log('cool');
```
|
