Adding TypeScript Support.

[zfcsoftware]

Adding TypeScript Support.

[elitan]

Here's what I did to get TypeScript to play nicely with this package:

1. Add a ./types/puppeteer-real-browser.d.ts file:

import { Browser, Page } from "puppeteer";

declare module "puppeteer-real-browser" {
  export interface ConnectOptions {
    args?: string[];
    headless?: string;
    customConfig?: Record<string, any>;
    proxy?: {
      username?: string;
      password?: string;
    };
    skipTarget?: string[];
    fingerprint?: boolean;
    turnstile?: boolean;
    connectOption?: Record<string, any>;
    fpconfig?: Record<string, any>;
  }

  export interface ConnectResult {
    browser: Browser;
    page: Page;
    xvfbsession: any;
    cdpSession: any;
    chrome: any;
    setTarget: (options: { status: boolean }) => void;
  }

  export function connect(options: ConnectOptions): Promise<ConnectResult>;
}

2. Update the tsconfig.json file.

This will ensure that our ./types/puppeteer-real-browser.d.ts file is considered by TypeScript.

    "typeRoots": ["./types"],

For reference, here's my fill tsconfig.json:

{
  "compilerOptions": {
    "target": "es2016",
    "module": "ESNext",
    "moduleResolution": "node",
    "rootDir": "./src",
    "typeRoots": ["./types"],
    "forceConsistentCasingInFileNames": true,
    "strict": true,
    "skipLibCheck": true
  },
  "include": ["./src/**/*"]
}

Hope it helps.

[zfcsoftware]

Hello, unfortunately we can't add typescript support at the moment, but there is an old version with typescript support coded by @CrispyyBaconx, you can try it.