Class PineHoverParam

Represents a hover parameter with documentation and parsing capabilities.

Constructors

Properties

argDocs: undefined | PineDocsManager
argType: string = ''
argVal: string = ''
argument: string = ''
arrow: string = ''
closingParen: string = ''
comma: string = ''
def: string = ''
displayType: string = ''
eqSign: string = ''
functionName: string = ''
line: undefined | string
mapDocs: undefined | PineDocsManager
qm: string = ''
wordRange: Range

Methods

  • Checks if the provided argument is not inside a string.

    Parameters

    • argument: string

      The argument to check.

    Returns undefined | boolean

    True if the argument is not inside a string, false otherwise.

  • Determines if the current context represents a parameter and processes its documentation.

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

    A tuple containing the documentation manager, the argument, and undefined, or undefined if processing fails.

  • Matches the argument within the given line of text.

    Parameters

    • line: string

      The line of text to search within.

    Returns null | RegExpMatchArray

    The match result or null if no match is found.

  • Processes the argument documentation to determine its display type and updates related properties.

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

    A tuple containing the documentation manager, the argument, and undefined, or undefined if processing fails.

  • Sets various properties based on the argument documentation.

    Returns void

    A tuple containing the documentation manager, the argument, and undefined, or undefined if processing fails.

Generated using TypeDoc