Theia API Documentation v1.77.0
    Preparing search index...

    Function registerPortAttributesProvider

    • If your extension listens on ports, consider registering a PortAttributesProvider to provide information about the ports. For example, a debug extension may know about debug ports in it's debuggee. By providing this information with a PortAttributesProvider the extension can tell the editor that these ports should be ignored, since they don't need to be user facing.

      The results of the PortAttributesProvider are merged with the user setting remote.portsAttributes. If the values conflict, the user setting takes precedence.

      Parameters

      • portSelector: PortAttributesSelector

        It is best practice to specify a port selector to avoid unnecessary calls to your provider. If you don't specify a port selector your provider will be called for every port, which will result in slower port forwarding for the user.

      • provider: PortAttributesProvider

      Returns Disposable