A strategy selected in runtime to query a Javadoc for a given version.

interface QueryStrategy {
    queryExtensionsWithTypesHtml($object: CheerioAPI): null | string;
    queryFieldDescription($field: Cheerio<Element>): Cheerio<Element>;
    queryFieldId($field: Cheerio<Element>): string;
    queryFieldModifiersText($signature: Cheerio<Element>): string;
    queryFieldSignature($field: Cheerio<Element>): Cheerio<Element>;
    queryFieldTables($object: CheerioAPI): Cheerio<Element>;
    queryFieldType($signature: Cheerio<Element>, signatureText: string): string;
    queryImplementationsWithTypesHtml($object: CheerioAPI): null | string;
    queryMemberDeprecation(
        $member: Cheerio<Element>,
    ): null | DeprecationContent;
    queryMethodDescription($method: Cheerio<Element>): Cheerio<Element>;
    queryMethodModifiersText($signature: Cheerio<Element>): string;
    queryMethodNameText(
        $method: Cheerio<Element>,
        $signature: Cheerio<Element>,
    ): string;
    queryMethodParameters(
        $signature: Cheerio<Element>,
        sanitizedSignature: string,
    ): null | Cheerio<Element>;
    queryMethodPrototypeText($method: Cheerio<Element>): string;
    queryMethodReturnType($signature: Cheerio<Element>): string;
    queryMethodSignature($method: Cheerio<Element>): Cheerio<Element>;
    queryMethodTables($object: CheerioAPI): Cheerio<Element>;
    queryObjectDeprecation($object: CheerioAPI): null | DeprecationContent;
    queryObjectDescription($object: CheerioAPI): Cheerio<Element>;
    queryObjectSignature($object: CheerioAPI): Cheerio<Element>;
    queryPackageContents($package: CheerioAPI): Cheerio<Element>;
    queryPackageDescription($package: CheerioAPI): Cheerio<Element>;
    queryPackageSignatureText($package: CheerioAPI): string;
    queryRelatedPackages($package: CheerioAPI): null | Cheerio<Element>;
    queryRootTabs($root: CheerioAPI): Cheerio<Element>;
    queryTypeParametersHeader($object: CheerioAPI): Cheerio<Element>;
}

Implemented by

Methods

  • Parameters

    • $object: CheerioAPI

    Returns null | string

  • Parameters

    • $field: Cheerio<Element>

    Returns Cheerio<Element>

  • Parameters

    • $field: Cheerio<Element>

    Returns string

  • Parameters

    • $signature: Cheerio<Element>

    Returns string

  • Parameters

    • $field: Cheerio<Element>

    Returns Cheerio<Element>

  • Parameters

    • $object: CheerioAPI

    Returns Cheerio<Element>

  • Parameters

    • $signature: Cheerio<Element>
    • signatureText: string

    Returns string

  • Parameters

    • $object: CheerioAPI

    Returns null | string

  • Parameters

    • $method: Cheerio<Element>

    Returns Cheerio<Element>

  • Parameters

    • $signature: Cheerio<Element>

    Returns string

  • Parameters

    • $method: Cheerio<Element>
    • $signature: Cheerio<Element>

    Returns string

  • Parameters

    • $signature: Cheerio<Element>
    • sanitizedSignature: string

    Returns null | Cheerio<Element>

  • Parameters

    • $method: Cheerio<Element>

    Returns string

  • Parameters

    • $signature: Cheerio<Element>

    Returns string

  • Parameters

    • $method: Cheerio<Element>

    Returns Cheerio<Element>

  • Parameters

    • $object: CheerioAPI

    Returns Cheerio<Element>

  • Parameters

    • $object: CheerioAPI

    Returns Cheerio<Element>

  • Parameters

    • $object: CheerioAPI

    Returns Cheerio<Element>

  • Parameters

    • $package: CheerioAPI

    Returns Cheerio<Element>

  • Parameters

    • $package: CheerioAPI

    Returns Cheerio<Element>

  • Parameters

    • $package: CheerioAPI

    Returns string

  • Parameters

    • $package: CheerioAPI

    Returns null | Cheerio<Element>

  • Parameters

    • $root: CheerioAPI

    Returns Cheerio<Element>

  • Parameters

    • $object: CheerioAPI

    Returns Cheerio<Element>