Class PackageScraper

Scrapes data from a package URL to a PartialPackageData.

Index

Constructors

Properties

annotationScraper classScraper enumScraper fetcher interfaceScraper

Methods

findRelatedPackages scrape scrapeContents

Constructors

constructor

new PackageScraper(
    options: {
        annotationScraper: AnnotationScraper;
        classScraper: ClassScraper;
        enumScraper: EnumScraper;
        fetcher: Fetcher;
        interfaceScraper: InterfaceScraper;
    },
): PackageScraper
Parameters
- options: {
      annotationScraper: AnnotationScraper;
      classScraper: ClassScraper;
      enumScraper: EnumScraper;
      fetcher: Fetcher;
      interfaceScraper: InterfaceScraper;
  }
Returns PackageScraper
- Defined in scrapers/package/PackageScraper.ts:27

Properties

`Protected` `Readonly`annotationScraper

annotationScraper: AnnotationScraper

`Protected` `Readonly`classScraper

classScraper: ClassScraper

`Protected` `Readonly`enumScraper

enumScraper: EnumScraper

`Protected` `Readonly`fetcher

fetcher: Fetcher

`Protected` `Readonly`interfaceScraper

interfaceScraper: InterfaceScraper

Methods

`Protected`findRelatedPackages

findRelatedPackages($: CheerioAPI, strategy: QueryStrategy): string[]
Parameters
- $: CheerioAPI
- strategy: QueryStrategy
Returns string[]
- Defined in scrapers/package/PackageScraper.ts:84

scrape

scrape(
    url: string,
    cache: ScrapeCache,
    strategy: QueryStrategy,
): Promise<PartialPackageData>
Parameters
- url: string
- cache: ScrapeCache
- strategy: QueryStrategy
Returns Promise<PartialPackageData>
- Defined in scrapers/package/PackageScraper.ts:41

`Protected`scrapeContents

scrapeContents(
    $: CheerioAPI,
    cache: ScrapeCache,
    packageData: PartialPackageData,
    strategy: QueryStrategy,
): Promise<void>
Parameters
- $: CheerioAPI
- cache: ScrapeCache
- packageData: PartialPackageData
- strategy: QueryStrategy
Returns Promise<void>
- Defined in scrapers/package/PackageScraper.ts:107