Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SignatureHelpProvider

The signature help provider interface defines the contract between extensions and the parameter hints-feature.

Hierarchy

  • SignatureHelpProvider

Index

Methods

provideSignatureHelp

  • Provide help for the signature at the given position and document.

    Parameters

    • document: TextDocument

      The document in which the command was invoked.

    • position: Position

      The position at which the command was invoked.

    • token: CancellationToken | undefined

      A cancellation token.

    Returns ProviderResult<SignatureHelp>

    Signature help or a thenable that resolves to such. The lack of a result can be signaled by returning undefined or null.