Each default tool provided by eruda can be accessed by eruda.get('Tool Name')
.
Display console logs. Implementation detail follows the console api spec.
Name | Type | Desc |
---|---|---|
asyncRender | boolean | Asynchronous rendering |
jsExecution | boolean | Enable JavaScript execution |
catchGlobalErr | boolean | Catch global errors |
overrideConsole | boolean | Override console |
displayExtraInfo | boolean | Display extra information |
displayUnenumerable | boolean | Display unenumerable properties |
displayGetterVal | boolean | Access getter value |
lazyEvaluation | boolean | Stringify object when clicked |
displayIfErr | boolean | Auto display if error occurs |
maxLogNum | string | Max log number |
let console = eruda.get('console');
console.config.set('catchGlobalErr', true);
log, error, info, warn, dir, time/timeLog/timeEnd, clear, count/countReset, assert, table, group/groupCollapsed/groupEnd
All these methods can be used in the same way as window.console object.
Note: When called, a corresponding event is triggered.
let console = eruda.get('console');
console.log('eruda is a console for %s.', 'mobile browsers');
console.table([{test: 1}, {test: 2}, {test2: 3}], 'test');
console.error(new Error('eruda'));
console.on('log', function ()
{
// Do whatever you want, send to server or save on local storage.
});
Filter logs.
Name | Type | Desc |
---|---|---|
filter | string regexp function | Custom filter |
console.filter('all'); // String parameter. Log, warn, debug, error is also supported.
console.filter(/^eruda/);
console.filter(function (log)
{
return log.type === 'error';
});
Log out html content.
Name | Type | Desc |
---|---|---|
html | string | Html string |
console.html('<span style="color:red">Red</span>');
Check dom element status.
Name | Type | Desc |
---|---|---|
overrideEventTarget | boolean | Catch Event Listeners |
observeElement | boolean | Auto Refresh |
Set dom element to show.
Name | Type | Desc |
---|---|---|
el | element | Element to display |
elements.set(document.body);
Display requests.
Name | Type | Desc |
---|---|---|
overrideFetch | boolean | Catch Fetch Requests |
Clear requests.
Get request data.
network.clear();
LocalStorage, sessionStorage, cookies, scripts, styleSheets and images.
Name | Type | Desc |
---|---|---|
hideErudaSetting | boolean | Hide Eruda Setting |
observeElement | boolean | Auto Refresh Elements |
View object, html, js, and css.
Name | Type | Desc |
---|---|---|
showLineNum | boolean | Show Line Numbers |
formatCode | boolean | Beautify Code |
indentSize | string | Indent Size |
Display special information, could be used for displaying user info to track user logs.
By default, page url and browser user agent is shown.
Clear infos.
Add info.
Name | Type | Desc |
---|---|---|
name | string | Info name |
content | string function | Info content |
info.add('title', 'content');
info.add('location', () => location.href);
Get info or infos.
Name | Type | Desc |
---|---|---|
name | string | Info name |
return | string function | Info content |
info.add('title', 'content')
info.get(); // -> [{name: 'title', val: 'content'}]
info.get('title') // -> 'content'
Remove specified info.
Name | Type | Desc |
---|---|---|
name | string | Info name |
info.remove('title');
Allow you to register small functions that can be triggered multiple times.
Clear snippets.
Add snippet.
Name | Type | Desc |
---|---|---|
name | string | Snippet name |
fn | function | Function to be triggered |
desc | string | Snippet description |
Remove specified snippet.
Name | Type | Desc |
---|---|---|
name | string | Snippet to remove |
Run specified snippet.
Name | Type | Desc |
---|---|---|
name | string | Snippet to run |
snippets.add('hello', function ()
{
console.log('Hello World!');
}, 'Display hello on console');
snippets.run('hello');
snippets.remove('hello');
Customization for all tools.
Clear settings.
Remove setting.
Name | Type | Desc |
---|---|---|
cfg | object | Config object |
name | string | Option name |
Add text.
Name | Type | Desc |
---|---|---|
str | string | String to display |
Add switch to toggle a boolean value.
Name | Type | Desc |
---|---|---|
cfg | object | Config object created by util.createCfg |
name | string | Option name |
desc | string | Option description |
Add select to select a number of string values.
Name | Type | Desc |
---|---|---|
cfg | object | Config object |
name | string | Option name |
desc | string | Option description |
values | array | Array of strings to select |
Add range to input a number.
Name | Type | Desc |
---|---|---|
cfg | object | Config object |
name | string | Option name |
desc | string | Option description |
option | object | Min, max, step |
Add color to select a color.
Name | Type | Desc |
---|---|---|
cfg | object | Config object |
name | string | Option name |
desc | string | Option description |
[color] | array | Color list |
Add a separator.
let cfg = eruda.util.createCfg('test');
cfg.set(eruda.util.defaults(cfg.get(), {
testBool: true,
testSelect: 'select1',
testRange: 1
}));
settings.text('Test')
.switch(cfg, 'testBool', 'Test Bool')
.select(cfg, 'testSelect', 'Test Select', ['select1', 'select2'])
.range(cfg, 'testRange', 'Test Range', {min: 0, max: 1, step: 0.1})
.separator();
settings.remove(cfg, 'testBool')