Class PineHoverFunction

Represents a PineHoverFunction.

Index

Constructors

Properties

Methods

isFunction processFunctionDocs

Constructors

constructor

new PineHoverFunction(keyedDocs, key): PineHoverFunction
Initializes a new instance of the PineHoverFunction class.
Parameters
- keyedDocs: PineDocsManager
  The PineDocsManager instance.
- key: string
  The key.
Returns PineHoverFunction
- Defined in src/PineHoverProvider/PineHoverIsFunction.ts:17

Properties

`Private` key

key: string

`Private` keyedDocs

keyedDocs: PineDocsManager

Methods

isFunction

isFunction(): Promise<undefined | [PineDocsManager, string, undefined]>
Checks if the function is a valid function.

Returns Promise<undefined | [PineDocsManager, string, undefined]>
A Promise that resolves to an array containing PineDocsManager, key, and undefined.
- Defined in src/PineHoverProvider/PineHoverIsFunction.ts:26

`Private` processFunctionDocs

processFunctionDocs(getDocs): void
Processes the function documentation.
Parameters
- getDocs: any[]
  The array of function documentation.
Returns void
- Defined in src/PineHoverProvider/PineHoverIsFunction.ts:78

Generated using TypeDoc