kotlin-vscode/vscode/TypeHierarchyProvider

TypeHierarchyProvider

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

Functions

abstract fun prepareTypeHierarchy(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<JsAny>

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.

provideTypeHierarchySubtypes

abstract fun provideTypeHierarchySubtypes(item: TypeHierarchyItem, token: CancellationToken): ProviderResult<ReadonlyArray<TypeHierarchyItem>>

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.

provideTypeHierarchySupertypes

abstract fun provideTypeHierarchySupertypes(item: TypeHierarchyItem, token: CancellationToken): ProviderResult<ReadonlyArray<TypeHierarchyItem>>

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.