Class BaseObjectScraper

constructor

• new BaseObjectScraper(
      options: {
          fetcher: Fetcher;
          fieldScraper: FieldScraper;
          inheritanceScraper: InheritanceScraper;
          methodScraper: MethodScraper;
      },
  ): BaseObjectScraper

• Parameters

  • options: {
        fetcher: Fetcher;
        fieldScraper: FieldScraper;
        inheritanceScraper: InheritanceScraper;
        methodScraper: MethodScraper;
    }

  Returns BaseObjectScraper

Static ReadonlyTypeParameterTextRegex

scrape

• scrape(
      $: CheerioAPI,
      fullUrl: string,
      packageData: PartialPackageData,
      strategy: QueryStrategy,
  ): {
      deprecation: null | DeprecationContent;
      description: { html: null | string; text: string };
      fields: Collection<string, FieldData<null>>;
      methods: Collection<string, MethodData<null>>;
      name: string;
      partialExtends: (string | ExternalEntityData)[];
      partialImplements: (string | ExternalEntityData)[];
      partialPackage: PartialPackageData;
      qualifiedName: string;
      signature: string;
      typeParameters: Collection<string, ObjectTypeParameterData>;
      url: string;
  }

• Parameters

  • $: CheerioAPI
  • fullUrl: string
  • packageData: PartialPackageData
  • strategy: QueryStrategy

  Returns {
      deprecation: null | DeprecationContent;
      description: { html: null | string; text: string };
      fields: Collection<string, FieldData<null>>;
      methods: Collection<string, MethodData<null>>;
      name: string;
      partialExtends: (string | ExternalEntityData)[];
      partialImplements: (string | ExternalEntityData)[];
      partialPackage: PartialPackageData;
      qualifiedName: string;
      signature: string;
      typeParameters: Collection<string, ObjectTypeParameterData>;
      url: string;
  }