@sergienko4/israeli-bank-scrapers - v8.2.1
    Preparing search index...

    Type Alias ScraperOptions

    ScraperOptions: ScraperBrowserOptions & {
        companyId: CompanyTypes;
        defaultTimeout?: number;
        futureMonthsToScrape?: number;
        includeRawTransaction?: boolean;
        loginLogLevel?: "info" | "trace";
        navigationRetryCount?: number;
        optInFeatures?: OptInFeatures[];
        otpCodeRetriever?: (phoneHint: string) => Promise<string>;
        outputData?: IOutputDataOptions;
        preparePage?: (page: Page) => LifecyclePromise;
        shouldAddTransactionInformation?: boolean;
        shouldCombineInstallments?: boolean;
        startDate: Date;
        storeFailureScreenShotPath?: string;
        usePipeline?: boolean;
        verbose?: boolean;
        viewportSize?: { height: number; width: number };
    }

    Type Declaration

    • companyId: CompanyTypes

      The company you want to scrape

    • OptionaldefaultTimeout?: number

      if set, will set the timeout in milliseconds of page.setDefaultTimeout.

    • OptionalfutureMonthsToScrape?: number

      scrape transactions to be processed X months in the future

    • OptionalincludeRawTransaction?: boolean

      Include the raw transaction object as received from the scraper source for debugging purposes.

      false
    • OptionalloginLogLevel?: "info" | "trace"

      Login chain log verbosity.

      • 'info' (default): chain plan, step pass/fail with timing, masked result summary.
      • 'trace': all of info plus per-step context (URL, frames, selectors). Falls back to LOG_LEVEL env var when not set.
    • OptionalnavigationRetryCount?: number

      The number of times to retry the navigation in case of a failure (default 0)

    • OptionaloptInFeatures?: OptInFeatures[]

      Opt-in features for the scrapers, allowing safe rollout of new breaking changes.

    • OptionalotpCodeRetriever?: (phoneHint: string) => Promise<string>

      Called when an OTP/2FA screen is detected after login form submission. Return the one-time code to continue scraping automatically.

    • OptionaloutputData?: IOutputDataOptions

      Options for manipulation of output data

    • OptionalpreparePage?: (page: Page) => LifecyclePromise

      Adjust the page instance before it is being used.

    • OptionalshouldAddTransactionInformation?: boolean

      Perform additional operation for each transaction to get more information (Like category) about it. Please note: It will take more time to finish the process.

    • OptionalshouldCombineInstallments?: boolean

      if set to true, all installment transactions will be combine into the first one

    • startDate: Date

      the date to fetch transactions from (can't be before the minimum allowed time difference for the scraper)

    • OptionalstoreFailureScreenShotPath?: string

      if set, store a screenshot if failed to scrape. Used for debug purposes

    • OptionalusePipeline?: boolean

      Opt-in to the new Pipeline architecture. When true, the factory routes to PipelineRegistry instead of the legacy scraper classes. Both old and new code coexist — set to true to use the new pipeline for migrated banks.

      false
    • Optionalverbose?: boolean

      include more debug info about in the output

    • OptionalviewportSize?: { height: number; width: number }

      Adjust the viewport size of the browser page. If not set, the default viewport size of 1024x768 will be used.

    Settings

    Member Visibility