puppeteer/new-docs/puppeteer.protocol.runtime.evaluaterequest.md
2020-07-13 14:01:35 +01:00

3.0 KiB

Home > puppeteer > Protocol > Runtime > EvaluateRequest

Protocol.Runtime.EvaluateRequest interface

Signature:

export interface EvaluateRequest 

Properties

Property Type Description
awaitPromise boolean Whether execution should await for resulting value and return once awaited promise is resolved.
contextId ExecutionContextId Specifies in which execution context to perform evaluation. If the parameter is omitted the evaluation will be performed in the context of the inspected page.
disableBreaks boolean Disable breakpoints during execution.
expression string Expression to evaluate.
generatePreview boolean Whether preview should be generated for the result.
includeCommandLineAPI boolean Determines whether Command Line API should be available during the evaluation.
objectGroup string Symbolic group name that can be used to release multiple objects.
replMode boolean Setting this flag to true enables let re-declaration and top-level await. Note that let variables can only be re-declared if they originate from replMode themselves.
returnByValue boolean Whether the result is expected to be a JSON object that should be sent by value.
silent boolean In silent mode exceptions thrown during evaluation are not reported and do not pause execution. Overrides setPauseOnException state.
throwOnSideEffect boolean Whether to throw an exception if side effect cannot be ruled out during evaluation. This implies disableBreaks below.
timeout TimeDelta Terminate execution after timing out (number of milliseconds).
userGesture boolean Whether execution should be treated as initiated by user in the UI.