Class MethodScraper

Protected Static ReadonlyTextTypeParameter

ProtectedextractAnnotations

• extractAnnotations(signature: string): string[]

• Parameters

  • signature: string

  Returns string[]

ProtectedextractNameAndDescription

• extractNameAndDescription(
      $element: Cheerio<Element>,
  ): {
      description: null | string;
      descriptionHtml: null | string;
      name: string;
  }

• Parameters

  • $element: Cheerio<Element>

  Returns { description: null | string; descriptionHtml: null | string; name: string }

ProtectedextractParameters

• extractParameters(
      $object: CheerioAPI,
      $method: Cheerio<Element>,
      $signature: Cheerio<Element>,
      sanitizedSignature: string,
      strategy: QueryStrategy,
  ): Collection<string, ParameterData>

• Parameters

  • $object: CheerioAPI
  • $method: Cheerio<Element>
  • $signature: Cheerio<Element>
  • sanitizedSignature: string
  • strategy: QueryStrategy

  Returns Collection<string, ParameterData>

ProtectedextractReturns

• extractReturns(
      $method: Cheerio<Element>,
      $signature: Cheerio<Element>,
      strategy: QueryStrategy,
  ): MethodReturnData

• Parameters

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

  Returns MethodReturnData

ProtectedextractTypeParameters

• extractTypeParameters(
      $method: Cheerio<Element>,
      signature: string,
  ): Collection<string, MethodTypeParameterData>

• Parameters

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

  Returns Collection<string, MethodTypeParameterData>