Interface ExternalEntityData

Data for an external entity, whose details cannot be fully scraped.

interface ExternalEntityData {
    description: null;
    entityType: "externalObject";
    id: string;
    name: string;
    qualifiedName: string;
    signature: string;
    url: string;
}

Hierarchy (View Summary)

Properties

description entityType id name qualifiedName signature url

Properties

description

description: null

External entities' descriptions cannot be scraped.

entityType

entityType: "externalObject"

The entity's type.

id

id: string

The entity's unique id (relative to others in the same context). Used as key in collections.

Specifically:

  • In classes, enums, interfaces, external objects and annotations: the qualifiedName.
  • In packages, enum constants, fields, method type parameters, object type parameters and parameters: the name.
  • In methods: the prototype, to avoid conflicts with overloaded methods.

name

name: string

The entity's name.

qualifiedName

qualifiedName: string

The entity's fully qualified name.

signature

signature: string

The entity's signature.

url

url: string

The entity's Javadocs URL.

Settings

Member Visibility

On This Page

Properties