Class Scraper

The entry point for the library.

Index

Constructors

Properties

annotationPatcher classPatcher enumPatcher fetcher interfacePatcher packagePatcher rootScraper scrapeCache strategyBundleFactory

Methods

scrape fromPath fromURL with

Constructors

constructor

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

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`rootScraper

rootScraper: RootScraper

`Protected` `Readonly`scrapeCache

scrapeCache: ScrapeCache = ...

`Protected` `Readonly`strategyBundleFactory

strategyBundleFactory: QueryStrategyBundleFactory

Methods

scrape

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

`Static`fromPath

fromPath(path: string): Scraper
Creates a new Scraper from a local file path.
Parameters
- path: string
Returns Scraper
- Defined in scrapers/Scraper.ts:72

`Static`fromURL

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

`Static`with

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