console.md

Table of Contents

• startListeners
• stopListeners
• getCachedMessages
• clearMessagesCache
• evaluateJS (Deprecated)
• evaluateJSAsync
• getPreferences
• setPreferences
• autocomplete
• inspectObjectProperties

startListeners

Start the given Web Console listeners.

Parameters

• listeners Array<String> listeners to listen to (default: 'PageError', 'ConsoleAPI') (optional, default Console.listeners)

Returns Promise<Object> request response

stopListeners

Stop the given Web Console listeners.

Parameters

• listeners Array<String> listeners to stop listen to (default: 'PageError', 'ConsoleAPI') (optional, default Console.listeners)

Returns Promise<Object> request response

getCachedMessages

Retrieve the cached messages from the server.

Parameters

• messageTypes Array<String> type of cached message to get (default: 'PageError', 'ConsoleAPI') (optional, default Console.listeners)

Returns Array<Promise<Object>> list of console messages

clearMessagesCache

Clear the cache of messages (console API calls only).

Returns Promise<Object> request response

evaluateJS

Evaluate a JavaScript expression.

Starting from FF72, this method becomes deprecated.

Please use evaluateJSAsync instead

Parameters

• script (String | Function) js code to evaluate
• args Object arguments to pass to the function

Returns Promise<Object, Error> result of the js function or an exception if script fails

evaluateJSAsync

Evaluate a JavaScript expression.

Parameters

• script (String | Function) js code to evaluate
• args Object arguments to pass to the function

Returns Promise<Object, Error> result of the js function or an exception if script fails

getPreferences

Get Web Console-related preferences on the server.

Parameters

• preferences Array<String> An array with the preferences you want to retrieve.

Returns Array<Promise<Object>> List of preferences

setPreferences

Set Web Console-related preferences on the server.

Parameters

• preferences Object An object with the preferences you want to change.

Returns Promise<Object> request response

autocomplete

Autocomplete a JavaScript expression.

Parameters

• text String The code you want to autocomplete.
• cursor Number Cursor location inside the string. Index starts from 0.

Returns Promise<Object> request response

inspectObjectProperties

Inspect the properties of an object.

Returns Promise<Object> request response