cdpConnection.d.ts 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. /**
  2. * Copyright 2021 Google LLC.
  3. * Copyright (c) Microsoft Corporation.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. */
  17. import type { ProtocolMapping } from 'devtools-protocol/types/protocol-mapping.js';
  18. import type { ITransport } from '../utils/transport.js';
  19. import type { LoggerFn } from '../utils/log.js';
  20. import { CdpClient, type ICdpClient } from './cdpClient.js';
  21. export interface ICdpConnection {
  22. browserClient(): ICdpClient;
  23. getCdpClient(sessionId: string): ICdpClient;
  24. }
  25. /**
  26. * Represents a high-level CDP connection to the browser backend.
  27. * Manages a CdpClient instance for each active CDP session.
  28. */
  29. export declare class CdpConnection implements ICdpConnection {
  30. #private;
  31. constructor(transport: ITransport, logger?: LoggerFn);
  32. /** Closes the connection to the browser. */
  33. close(): void;
  34. /** The CdpClient object attached to the root browser session. */
  35. browserClient(): CdpClient;
  36. /**
  37. * Gets a CdpClient instance attached to the given session ID,
  38. * or null if the session is not attached.
  39. */
  40. getCdpClient(sessionId: string): CdpClient;
  41. sendCommand<CdpMethod extends keyof ProtocolMapping.Commands>(method: CdpMethod, params?: ProtocolMapping.Commands[CdpMethod]['paramsType'][0], sessionId?: string): Promise<object>;
  42. }