Class PineHoverMethod

Constructors

Properties

docs: undefined | PineDocsManager
funcNamespace: null | string = null
functionName: string = ''
line: undefined | string = undefined
namespace: string = ''
varNamespace: null | string = null
wordRange: Range

Methods

  • Finds documentation for methods.

    Parameters

    • methods: string[]

      The methods.

    Returns Promise<undefined | [undefined | PineDocsManager, undefined | string, undefined | string]>

    A Promise that resolves to an array containing PineDocsManager, key, and namespace.

  • Gets documentation from the function map.

    Parameters

    • funcMap: Map<string, any>

      The function map.

    • type: string

      The type.

    • functionName: string

      The function name.

    Returns Promise<undefined | PineDocsManager>

    A Promise that resolves to PineDocsManager.

  • Checks if the method is a valid method.

    Returns Promise<undefined | [undefined | PineDocsManager, undefined | string, undefined | string]>

    A Promise that resolves to an array containing PineDocsManager, key, and namespace.

  • Splits the namespace and function name.

    Parameters

    • key: string

      The key.

    Returns {
        functionName: string;
        namespace: string;
    }

    An object containing the namespace and function name.

    • functionName: string
    • namespace: string

Generated using TypeDoc