Source code
Revision control
Copy as Markdown
Other Tools
/**
* @license
* Copyright 2020 Google Inc.
* SPDX-License-Identifier: Apache-2.0
*/
import type {JSHandle} from '../api/JSHandle.js';
/**
* @public
*/
export interface ConsoleMessageLocation {
/**
* URL of the resource if known or `undefined` otherwise.
*/
url?: string;
/**
* 0-based line number in the resource if known or `undefined` otherwise.
*/
lineNumber?: number;
/**
* 0-based column number in the resource if known or `undefined` otherwise.
*/
columnNumber?: number;
}
/**
* The supported types for console messages.
* @public
*/
export type ConsoleMessageType =
| 'log'
| 'debug'
| 'info'
| 'error'
| 'warn'
| 'dir'
| 'dirxml'
| 'table'
| 'trace'
| 'clear'
| 'startGroup'
| 'startGroupCollapsed'
| 'endGroup'
| 'assert'
| 'profile'
| 'profileEnd'
| 'count'
| 'timeEnd'
| 'verbose';
/**
* ConsoleMessage objects are dispatched by page via the 'console' event.
* @public
*/
export class ConsoleMessage {
#type: ConsoleMessageType;
#text: string;
#args: JSHandle[];
#stackTraceLocations: ConsoleMessageLocation[];
/**
* @internal
*/
constructor(
type: ConsoleMessageType,
text: string,
args: JSHandle[],
stackTraceLocations: ConsoleMessageLocation[]
) {
this.#type = type;
this.#text = text;
this.#args = args;
this.#stackTraceLocations = stackTraceLocations;
}
/**
* The type of the console message.
*/
type(): ConsoleMessageType {
return this.#type;
}
/**
* The text of the console message.
*/
text(): string {
return this.#text;
}
/**
* An array of arguments passed to the console.
*/
args(): JSHandle[] {
return this.#args;
}
/**
* The location of the console message.
*/
location(): ConsoleMessageLocation {
return this.#stackTraceLocations[0] ?? {};
}
/**
* The array of locations on the stack of the console message.
*/
stackTrace(): ConsoleMessageLocation[] {
return this.#stackTraceLocations;
}
}