2020-05-13 10:30:29 +00:00
|
|
|
/**
|
|
|
|
* Copyright 2020 Google Inc. All rights reserved.
|
|
|
|
*
|
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
* you may not use this file except in compliance with the License.
|
|
|
|
* You may obtain a copy of the License at
|
|
|
|
*
|
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
*
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
* See the License for the specific language governing permissions and
|
|
|
|
* limitations under the License.
|
|
|
|
*/
|
|
|
|
|
2020-07-13 09:22:26 +00:00
|
|
|
import { JSHandle } from './JSHandle.js';
|
2020-05-13 10:30:29 +00:00
|
|
|
|
2020-06-22 12:52:39 +00:00
|
|
|
/**
|
|
|
|
* @public
|
|
|
|
*/
|
|
|
|
export interface ConsoleMessageLocation {
|
|
|
|
/**
|
|
|
|
* URL of the resource if known or `undefined` otherwise.
|
|
|
|
*/
|
2020-05-13 10:30:29 +00:00
|
|
|
url?: string;
|
2020-06-22 12:52:39 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 0-based line number in the resource if known or `undefined` otherwise.
|
|
|
|
*/
|
2020-05-13 10:30:29 +00:00
|
|
|
lineNumber?: number;
|
2020-06-22 12:52:39 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 0-based column number in the resource if known or `undefined` otherwise.
|
|
|
|
*/
|
2020-05-13 10:30:29 +00:00
|
|
|
columnNumber?: number;
|
|
|
|
}
|
|
|
|
|
2020-06-22 12:52:39 +00:00
|
|
|
/**
|
|
|
|
* The supported types for console messages.
|
2021-04-06 08:58:01 +00:00
|
|
|
* @public
|
2020-06-22 12:52:39 +00:00
|
|
|
*/
|
2020-06-23 14:02:22 +00:00
|
|
|
export type ConsoleMessageType =
|
|
|
|
| 'log'
|
|
|
|
| 'debug'
|
|
|
|
| 'info'
|
|
|
|
| 'error'
|
|
|
|
| 'warning'
|
|
|
|
| 'dir'
|
|
|
|
| 'dirxml'
|
|
|
|
| 'table'
|
|
|
|
| 'trace'
|
|
|
|
| 'clear'
|
|
|
|
| 'startGroup'
|
|
|
|
| 'startGroupCollapsed'
|
|
|
|
| 'endGroup'
|
|
|
|
| 'assert'
|
|
|
|
| 'profile'
|
|
|
|
| 'profileEnd'
|
|
|
|
| 'count'
|
|
|
|
| 'timeEnd'
|
|
|
|
| 'verbose';
|
2020-06-22 12:52:39 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* ConsoleMessage objects are dispatched by page via the 'console' event.
|
|
|
|
* @public
|
|
|
|
*/
|
2020-05-13 10:30:29 +00:00
|
|
|
export class ConsoleMessage {
|
2022-06-13 09:16:25 +00:00
|
|
|
#type: ConsoleMessageType;
|
|
|
|
#text: string;
|
|
|
|
#args: JSHandle[];
|
|
|
|
#stackTraceLocations: ConsoleMessageLocation[];
|
2020-05-13 10:30:29 +00:00
|
|
|
|
2020-06-22 12:52:39 +00:00
|
|
|
/**
|
|
|
|
* @public
|
|
|
|
*/
|
2020-05-13 10:30:29 +00:00
|
|
|
constructor(
|
2020-06-22 12:52:39 +00:00
|
|
|
type: ConsoleMessageType,
|
2020-05-13 10:30:29 +00:00
|
|
|
text: string,
|
|
|
|
args: JSHandle[],
|
2020-09-25 13:27:13 +00:00
|
|
|
stackTraceLocations: ConsoleMessageLocation[]
|
2020-05-13 10:30:29 +00:00
|
|
|
) {
|
2022-06-13 09:16:25 +00:00
|
|
|
this.#type = type;
|
|
|
|
this.#text = text;
|
|
|
|
this.#args = args;
|
|
|
|
this.#stackTraceLocations = stackTraceLocations;
|
2020-05-13 10:30:29 +00:00
|
|
|
}
|
|
|
|
|
2020-06-22 12:52:39 +00:00
|
|
|
/**
|
|
|
|
* @returns The type of the console message.
|
|
|
|
*/
|
|
|
|
type(): ConsoleMessageType {
|
2022-06-13 09:16:25 +00:00
|
|
|
return this.#type;
|
2020-05-13 10:30:29 +00:00
|
|
|
}
|
|
|
|
|
2020-06-22 12:52:39 +00:00
|
|
|
/**
|
|
|
|
* @returns The text of the console message.
|
|
|
|
*/
|
2020-05-13 10:30:29 +00:00
|
|
|
text(): string {
|
2022-06-13 09:16:25 +00:00
|
|
|
return this.#text;
|
2020-05-13 10:30:29 +00:00
|
|
|
}
|
|
|
|
|
2020-06-22 12:52:39 +00:00
|
|
|
/**
|
|
|
|
* @returns An array of arguments passed to the console.
|
|
|
|
*/
|
2020-05-13 10:30:29 +00:00
|
|
|
args(): JSHandle[] {
|
2022-06-13 09:16:25 +00:00
|
|
|
return this.#args;
|
2020-05-13 10:30:29 +00:00
|
|
|
}
|
|
|
|
|
2020-06-22 12:52:39 +00:00
|
|
|
/**
|
|
|
|
* @returns The location of the console message.
|
|
|
|
*/
|
2020-05-13 10:30:29 +00:00
|
|
|
location(): ConsoleMessageLocation {
|
2022-06-13 09:16:25 +00:00
|
|
|
return this.#stackTraceLocations[0] ?? {};
|
2020-09-25 13:27:13 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @returns The array of locations on the stack of the console message.
|
|
|
|
*/
|
|
|
|
stackTrace(): ConsoleMessageLocation[] {
|
2022-06-13 09:16:25 +00:00
|
|
|
return this.#stackTraceLocations;
|
2020-05-13 10:30:29 +00:00
|
|
|
}
|
|
|
|
}
|