Class AnnotationElementScraper

Index

Constructors

Methods

extractAnnotations extractReturns scrape

Constructors

constructor

new AnnotationElementScraper(): AnnotationElementScraper
Returns AnnotationElementScraper

Methods

`Protected`extractAnnotations

extractAnnotations(signature: string): string[]
Parameters
- signature: string
Returns string[]
- Defined in scrapers/annotation/AnnotationElementScraper.ts:109

`Protected`extractReturns

extractReturns(
    $element: Cheerio<Element>,
    $signature: Cheerio<Element>,
    annotationStrategy: AnnotationQueryStrategy,
): MethodReturnData
Parameters
- $element: Cheerio<Element>
- $signature: Cheerio<Element>
- annotationStrategy: AnnotationQueryStrategy
Returns MethodReturnData
- Defined in scrapers/annotation/AnnotationElementScraper.ts:82

scrape

scrape(
    options: {
        $object: CheerioAPI;
        annotationStrategy: AnnotationQueryStrategy;
        objectUrl: string;
    },
): Collection<string, AnnotationElementData>
Parameters
- options: {
      $object: CheerioAPI;
      annotationStrategy: AnnotationQueryStrategy;
      objectUrl: string;
  }
Returns Collection<string, AnnotationElementData>
- Defined in scrapers/annotation/AnnotationElementScraper.ts:14