Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TypeHierarchyProvider

The type hierarchy provider interface describes the contract between extensions and the type hierarchy feature.

Hierarchy

  • TypeHierarchyProvider

Index

Methods(3)

prepareTypeHierarchy

  • Bootstraps type hierarchy by returning the item that is denoted by the given document and position. This item will be used as entry into the type graph. Providers should return undefined or null when there is no item at the given location.

    Parameters

    Returns ProviderResult<TypeHierarchyItem | TypeHierarchyItem[]>

    One or multiple type hierarchy items or a thenable that resolves to such. The lack of a result can be signaled by returning undefined, null, or an empty array.

provideTypeHierarchySupertypes

  • Provide all supertypes for an item, e.g all types from which a type is derived/inherited. In graph terms this describes directed and annotated edges inside the type graph, e.g the given item is the starting node and the result is the nodes that can be reached.

    Parameters

    Returns ProviderResult<TypeHierarchyItem[]>

    A set of direct supertypes or a thenable that resolves to such. The lack of a result can be signaled by returning undefined or null.

provideTypeHierarchySubtypes

  • Provide all subtypes for an item, e.g all types which are derived/inherited from the given item. In graph terms this describes directed and annotated edges inside the type graph, e.g the given item is the starting node and the result is the nodes that can be reached.

    Parameters

    Returns ProviderResult<TypeHierarchyItem[]>

    A set of direct subtypes or a thenable that resolves to such. The lack of a result can be signaled by returning undefined or null.

Generated by TypeDoc. Maintained by 洛竹