Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "wordpress-plugins/real-cookie-banner/src/public/ts/hooks/useScannerFromSitemap"

Index

Type aliases

UseScannerProgressParameters

UseScannerProgressParameters: Parameters<typeof useScannerProgress>

Functions

useScannerFromSitemap

  • useScannerFromSitemap(fetchStatusInterval?: UseScannerProgressParameters[0], fetchAdditionalData?: UseScannerProgressParameters[1]): { handleStart: (Anonymous function); remaining: number; setStep: Dispatch<SetStateAction<ScanFromSitemapStep>>; step: ScanFromSitemapStep; stepText: string }
  • Returns a callback which can be used within your button. It automatically collects all scannable urls and posts it to the queue.

    Parameters

    • Optional fetchStatusInterval: UseScannerProgressParameters[0]
    • Optional fetchAdditionalData: UseScannerProgressParameters[1]

    Returns { handleStart: (Anonymous function); remaining: number; setStep: Dispatch<SetStateAction<ScanFromSitemapStep>>; step: ScanFromSitemapStep; stepText: string }

Generated using TypeDoc