Class Scraper

The entry point for the library.

Index

Constructors

Properties

annotationPatcher classPatcher enumPatcher fetcher interfacePatcher packagePatcher queryStrategyFactory rootScraper scrapeCache

Methods

scrape fromURL with

Constructors

constructor

new Scraper(
    options: {
        annotationPatcher: AnnotationPatcher;
        classPatcher: ClassPatcher;
        enumPatcher: EnumPatcher;
        fetcher: Fetcher;
        interfacePatcher: InterfacePatcher;
        packagePatcher: PackagePatcher;
        packageScraper: PackageScraper;
        queryStrategyFactory: QueryStrategyFactory;
        rootScraper: RootScraper;
    },
): Scraper
Parameters
- options: {
      annotationPatcher: AnnotationPatcher;
      classPatcher: ClassPatcher;
      enumPatcher: EnumPatcher;
      fetcher: Fetcher;
      interfacePatcher: InterfacePatcher;
      packagePatcher: PackagePatcher;
      packageScraper: PackageScraper;
      queryStrategyFactory: QueryStrategyFactory;
      rootScraper: RootScraper;
  }
Returns Scraper
- Defined in scrapers/Scraper.ts:42

Properties

`Protected` `Readonly`annotationPatcher

annotationPatcher: AnnotationPatcher

`Protected` `Readonly`classPatcher

classPatcher: ClassPatcher

`Protected` `Readonly`enumPatcher

enumPatcher: EnumPatcher

`Protected` `Readonly`fetcher

fetcher: Fetcher

`Protected` `Readonly`interfacePatcher

interfacePatcher: InterfacePatcher

`Protected` `Readonly`packagePatcher

packagePatcher: PackagePatcher

`Protected` `Readonly`queryStrategyFactory

queryStrategyFactory: QueryStrategyFactory

`Protected` `Readonly`rootScraper

rootScraper: RootScraper

`Protected` `Readonly`scrapeCache

scrapeCache: ScrapeCache = ...

Methods

scrape

scrape(): Promise<Javadocs>
Returns Promise<Javadocs>
- Defined in scrapers/Scraper.ts:121

`Static`fromURL

fromURL(url: string): Scraper
Creates a new Scraper from a URL.
Parameters
- url: string
Returns Scraper
- Defined in scrapers/Scraper.ts:64

`Static`with

with(
    options: {
        fetcher: Fetcher;
        queryStrategyFactory?: QueryStrategyFactory;
    },
): Scraper
Creates a new Scraper with a Fetcher and optional QueryStrategyFactory.
Parameters
- options: { fetcher: Fetcher; queryStrategyFactory?: QueryStrategyFactory }
Returns Scraper
- Defined in scrapers/Scraper.ts:70