mirror of https://gitee.com/bigwinds/arangodb
200 lines
4.9 KiB
Markdown
200 lines
4.9 KiB
Markdown
Module "console"{#JSModuleConsole}
|
|
==================================
|
|
|
|
@NAVIGATE_JSModuleConsole
|
|
@EMBEDTOC{JSModuleConsoleTOC}
|
|
|
|
Console Module{#JSModuleConsoleIntro}
|
|
=====================================
|
|
|
|
The implementation follows the CommonJS specification
|
|
@S_EXTREF{http://wiki.commonjs.org/wiki/Console,Console}.
|
|
|
|
console.assert{#JSModuleConsoleAssert}
|
|
--------------------------------------
|
|
|
|
@FUN{console.assert(@FA{expression}, @FA{format}, @FA{argument1}, ...)}
|
|
|
|
Tests that an expression is `true`. If not, logs a message and throws
|
|
an exception.
|
|
|
|
Example usage:
|
|
|
|
console.assert(value === "abc", "expected: value === abc, actual:", value);
|
|
|
|
@CLEARPAGE
|
|
console.debug{#JSModuleConsoleDebug}
|
|
------------------------------------
|
|
|
|
@FUN{console.debug(@FA{format}, @FA{argument1}, ...)}
|
|
|
|
Formats the arguments according to @FA{format} and logs the result as
|
|
debug message. Note that debug messages will only be logged if the
|
|
server is started with log levels `debug` or `trace`. Please refer to
|
|
@ref CommandLineLoggingHuman for details.
|
|
|
|
String substitution patterns, which can be used in @FA{format}.
|
|
|
|
- `%%s` string
|
|
- `%%d`, `%%i` integer
|
|
- `%%f` floating point number
|
|
- `%%o` object hyperlink
|
|
|
|
Example usage:
|
|
|
|
console.debug("%s", "this is a test");
|
|
|
|
@CLEARPAGE
|
|
console.dir{#JSModuleConsoleDir}
|
|
--------------------------------
|
|
|
|
@FUN{console.dir(@FA{object})}
|
|
|
|
Logs a listing of all properties of the object.
|
|
|
|
Example usage:
|
|
|
|
console.dir(myObject);
|
|
|
|
@CLEARPAGE
|
|
console.error{#JSModuleConsoleError}
|
|
------------------------------------
|
|
|
|
@FUN{console.error(@FA{format}, @FA{argument1}, ...)}
|
|
|
|
Formats the arguments according to @FA{format} and logs the result as
|
|
error message.
|
|
|
|
String substitution patterns, which can be used in @FA{format}.
|
|
|
|
- `%%s` string
|
|
- `%%d`, `%%i` integer
|
|
- `%%f` floating point number
|
|
- `%%o` object hyperlink
|
|
|
|
Example usage:
|
|
|
|
console.error("error '%s': %s", type, message);
|
|
|
|
@CLEARPAGE
|
|
console.getline{#JSModuleConsoleGetline}
|
|
----------------------------------------
|
|
|
|
@FUN{console.getline()}
|
|
|
|
Reads in a line from the console and returns it as string.
|
|
|
|
@CLEARPAGE
|
|
console.group{#JSModuleConsoleGroup}
|
|
------------------------------------
|
|
|
|
@FUN{console.group(@FA{format}, @FA{argument1}, ...)}
|
|
|
|
Formats the arguments according to @FA{format} and logs the result as
|
|
log message. Opens a nested block to indent all future messages
|
|
sent. Call @FN{groupEnd} to close the block. Representation of block
|
|
is up to the platform, it can be an interactive block or just a set of
|
|
indented sub messages.
|
|
|
|
Example usage:
|
|
|
|
console.group("user attributes");
|
|
console.log("name", user.name);
|
|
console.log("id", user.id);
|
|
console.groupEnd();
|
|
|
|
@CLEARPAGE
|
|
console.groupCollapsed{#JSModuleConsoleGroupCollapsed}
|
|
------------------------------------------------------
|
|
|
|
@FUN{console.groupCollapsed(@FA{format}, @FA{argument1}, ...)}
|
|
|
|
Same as `console.group`, but with the group initially collapsed.
|
|
|
|
@CLEARPAGE
|
|
console.groupEnd{#JSModuleConsoleGroupEnd}
|
|
------------------------------------------
|
|
|
|
@FUN{console.groupEnd()}
|
|
|
|
Closes the most recently opened block created by a call to @FN{group}.
|
|
|
|
@CLEARPAGE
|
|
console.info{#JSModuleConsoleInfo}
|
|
----------------------------------
|
|
|
|
@FUN{console.info(@FA{format}, @FA{argument1}, ...)}
|
|
|
|
Formats the arguments according to @FA{format} and logs the result as
|
|
info message.
|
|
|
|
String substitution patterns, which can be used in @FA{format}.
|
|
|
|
- `%%s` string
|
|
- `%%d`, `%%i` integer
|
|
- `%%f` floating point number
|
|
- `%%o` object hyperlink
|
|
|
|
Example usage:
|
|
|
|
console.info("The %s jumped over %d fences", animal, count);
|
|
|
|
@CLEARPAGE
|
|
console.log{#JSModuleConsoleLog}
|
|
--------------------------------
|
|
|
|
@FUN{console.log(@FA{format}, @FA{argument1}, ...)}
|
|
|
|
Formats the arguments according to @FA{format} and logs the result as
|
|
log message. This is an alias for `console.info`.
|
|
|
|
@CLEARPAGE
|
|
console.time{#JSModuleConsoleTime}
|
|
----------------------------------
|
|
|
|
@FUN{console.time(@FA{name})}
|
|
|
|
Creates a new timer under the given name. Call @FN{timeEnd} with the
|
|
same name to stop the timer and log the time elapsed.
|
|
|
|
Example usage:
|
|
|
|
console.time("mytimer");
|
|
...
|
|
console.timeEnd("mytimer"); // this will print the elapsed time
|
|
|
|
@CLEARPAGE
|
|
console.timeEnd{#JSModuleConsoleTimeEnd}
|
|
----------------------------------------
|
|
|
|
@FUN{console.timeEnd(@FA{name})}
|
|
|
|
Stops a timer created by a call to @FN{time} and logs the time elapsed.
|
|
|
|
@CLEARPAGE
|
|
console.timeEnd{#JSModuleConsoleTrace}
|
|
--------------------------------------
|
|
|
|
@FUN{console.trace()}
|
|
|
|
Logs a stack trace of JavaScript execution at the point where it is
|
|
called.
|
|
|
|
@CLEARPAGE
|
|
console.warn{#JSModuleConsoleWarn}
|
|
----------------------------------
|
|
|
|
@FUN{console.warn(@FA{format}, @FA{argument1}, ...)}
|
|
|
|
Formats the arguments according to @FA{format} and logs the result as
|
|
warn message.
|
|
|
|
String substitution patterns, which can be used in @FA{format}.
|
|
|
|
- `%%s` string
|
|
- `%%d`, `%%i` integer
|
|
- `%%f` floating point number
|
|
- `%%o` object hyperlink
|
|
|
|
@BNAVIGATE_JSModuleConsole
|