123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239
/** * Copyright 2019 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. */import { Protocol } from "../../vendor/devtools-protocol/types/protocol.d.ts";import { CDPSession } from "./Connection.js";import type { ElementHandle } from "./ElementHandle.js";import { ExecutionContext } from "./ExecutionContext.js";import { MouseButton } from "./Input.js";import { EvaluateFunc, HandleFor, HandleOr } from "./types.js";declare const __JSHandleSymbol: unique symbol;/** * @public */export interface BoxModel {  content: Point[];  padding: Point[];  border: Point[];  margin: Point[];  width: number;  height: number;}/** * @public */export interface BoundingBox extends Point {  /**   * the width of the element in pixels.   */  width: number;  /**   * the height of the element in pixels.   */  height: number;}/** * Represents a reference to a JavaScript object. Instances can be created using * {@link Page.evaluateHandle}. * * Handles prevent the referenced JavaScript object from being garbage-collected * unless the handle is purposely {@link JSHandle.dispose | disposed}. JSHandles * are auto-disposed when their associated frame is navigated away or the parent * context gets destroyed. * * Handles can be used as arguments for any evaluation function such as * {@link Page.$eval}, {@link Page.evaluate}, and {@link Page.evaluateHandle}. * They are resolved to their referenced object. * * @example * * ```ts * const windowHandle = await page.evaluateHandle(() => window); * ``` * * @public */export declare class JSHandle<T = unknown> {  #private;  /**   * Used for nominally typing {@link JSHandle}.   */  [__JSHandleSymbol]?: T;  /**   * @internal   */  get client(): CDPSession;  /**   * @internal   */  get disposed(): boolean;  /**   * @internal   */  constructor(    context: ExecutionContext,    client: CDPSession,    remoteObject: Protocol.Runtime.RemoteObject,  );  /**   * @returns The execution context the handle belongs to.   */  executionContext(): ExecutionContext;  /**   * Evaluates the given function with the current handle as its first argument.   *   * @see {@link ExecutionContext.evaluate} for more details.   */  evaluate<    Params extends unknown[],    Func extends EvaluateFunc<[this, ...Params]> = EvaluateFunc<[      this,      ...Params,    ]>,  >(    pageFunction: Func | string,    ...args: Params  ): Promise<Awaited<ReturnType<Func>>>;  /**   * Evaluates the given function with the current handle as its first argument.   *   * @see {@link ExecutionContext.evaluateHandle} for more details.   */  evaluateHandle<    Params extends unknown[],    Func extends EvaluateFunc<[this, ...Params]> = EvaluateFunc<[      this,      ...Params,    ]>,  >(    pageFunction: Func | string,    ...args: Params  ): Promise<HandleFor<Awaited<ReturnType<Func>>>>;  /**   * Fetches a single property from the referenced object.   */  getProperty<K extends keyof T>(    propertyName: HandleOr<K>,  ): Promise<HandleFor<T[K]>>;  getProperty(propertyName: string): Promise<JSHandle<unknown>>;  /**   * Gets a map of handles representing the properties of the current handle.   *   * @example   *   * ```ts   * const listHandle = await page.evaluateHandle(() => document.body.children);   * const properties = await listHandle.getProperties();   * const children = [];   * for (const property of properties.values()) {   *   const element = property.asElement();   *   if (element) {   *     children.push(element);   *   }   * }   * children; // holds elementHandles to all children of document.body   * ```   */  getProperties(): Promise<Map<string, JSHandle>>;  /**   * @returns A vanilla object representing the serializable portions of the   * referenced object.   * @throws Throws if the object cannot be serialized due to circularity.   *   * @remarks   * If the object has a `toJSON` function, it **will not** be called.   */  jsonValue(): Promise<T>;  /**   * @returns Either `null` or the handle itself if the handle is an   * instance of {@link ElementHandle}.   */  asElement(): ElementHandle<any> | null;  /**   * Releases the object referenced by the handle for garbage collection.   */  dispose(): Promise<void>;  /**   * Returns a string representation of the JSHandle.   *   * @remarks   * Useful during debugging.   */  toString(): string;  /**   * Provides access to the   * [Protocol.Runtime.RemoteObject](https://chromedevtools.github.io/devtools-protocol/tot/Runtime/#type-RemoteObject)   * backing this handle.   */  remoteObject(): Protocol.Runtime.RemoteObject;}/** * @public */export interface Offset {  /**   * x-offset for the clickable point relative to the top-left corder of the border box.   */  x: number;  /**   * y-offset for the clickable point relative to the top-left corder of the border box.   */  y: number;}/** * @public */export interface ClickOptions {  /**   * Time to wait between `mousedown` and `mouseup` in milliseconds.   *   * @defaultValue 0   */  delay?: number;  /**   * @defaultValue 'left'   */  button?: MouseButton;  /**   * @defaultValue 1   */  clickCount?: number;  /**   * Offset for the clickable point relative to the top-left corder of the border box.   */  offset?: Offset;}/** * @public */export interface PressOptions {  /**   * Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0.   */  delay?: number;  /**   * If specified, generates an input event with this text.   */  text?: string;}/** * @public */export interface Point {  x: number;  y: number;}export {};