Class PineDocsManager

constructor

• new PineDocsManager(): PineDocsManager

• Constructor for PineDocsManager class. It initializes class properties and loads documentation from 'pineDocs.json' into the Docs property.

  Returns PineDocsManager

Docs

UDTDocs

aliases

annotationsDocs

cleaned

completionFunctionsDocs

constantsDocs

controlsDocs

docAliases

fields2Docs

fieldsDocs

functions2Docs

functionsDocs

importAliases

importsDocs

methods2Docs

methodsDocs

typesDocs

variables2Docs

variablesDocs

getAliases

• get getAliases(): string[]

• the getAliases function is used to get the aliases for the current document

  Returns string[]

  The aliases.

setImportAliases

• set setImportAliases(aliases): void

• the setImportAliases function is used to set the imported namespace aliases

  Parameters

  • aliases: string[]

    The aliases to set.

  Returns void

cleanDocs

• cleanDocs(): void

• the cleanDocs function is used to clean the docs

  Returns void

  The cleaned docs.

getAnnotations

• getAnnotations(): Record<string, any>[]

• Retrieves the annotations documentation.

  Returns Record<string, any>[]

  The annotations documentation.

getCompletionFunctions

• getCompletionFunctions(): Record<string, any>[]

• Retrieves the completion functions documentation.

  Returns Record<string, any>[]

  The completion functions documentation.

getConstants

• getConstants(): Record<string, any>[]

• Retrieves the constants documentation.

  Returns Record<string, any>[]

  The constants documentation.

getControls

• getControls(): Record<string, any>[]

• Retrieves the controls documentation.

  Returns Record<string, any>[]

  The controls documentation.

getDocs

• getDocs(...keys): unknown[]

• the getDocs function is used to get the docs for a given key

  Parameters

  • Rest ...keys: string[]

    The keys to get the docs for.

  Returns unknown[]

  The docs.

getFields

• getFields(): Record<string, any>[]

• Retrieves the fields documentation.

  Returns Record<string, any>[]

  The fields documentation.

getFields2

• getFields2(): Record<string, any>[]

• Retrieves the second set of fields documentation.

  Returns Record<string, any>[]

  The second set of fields documentation.

getFunctions

• getFunctions(): Record<string, any>[]

• Retrieves the functions documentation.

  Returns Record<string, any>[]

  The functions documentation.

getFunctions2

• getFunctions2(): Record<string, any>[]

• Retrieves the second set of functions documentation.

  Returns Record<string, any>[]

  The second set of functions documentation.

getImports

• getImports(): Record<string, any>[]

• Retrieves the imports documentation.

  Returns Record<string, any>[]

  The imports documentation.

getMap

• getMap(...keys): Map<string, PineDocsManager>

• Returns a Map where the key is the 'name' property from the docs and the value is the doc object

  Parameters

  • Rest ...keys: string[]

    The keys to get the map for.

  Returns Map<string, PineDocsManager>

  The map.

getMethods

• getMethods(): Record<string, any>[]

• Retrieves the methods documentation.

  Returns Record<string, any>[]

  The methods documentation.

getMethods2

• getMethods2(): Record<string, any>[]

• Retrieves the second set of methods documentation.

  Returns Record<string, any>[]

  The second set of methods documentation.

getSwitch

• getSwitch(key): Record<string, any>[]

• Retrieves the typedocs for the getSwitch function.

  Parameters

  • key: string

    The key to switch on.

  Returns Record<string, any>[]

  The typedocs for the getSwitch function.

getTypes

• getTypes(): Record<string, any>[]

• Retrieves the types documentation.

  Returns Record<string, any>[]

  The types documentation.

getUDT

• getUDT(): Record<string, any>[]

• Retrieves the UDT (User-Defined Types) documentation.

  Returns Record<string, any>[]

  The UDT documentation.

getVariables

• getVariables(): Record<string, any>[]

• Retrieves the variables documentation.

  Returns Record<string, any>[]

  The variables documentation.

getVariables2

• getVariables2(): Record<string, any>[]

• Retrieves the second set of variables documentation.

  Returns Record<string, any>[]

  The second set of variables documentation.

makeMap

• makeMap(docs): Map<string, PineDocsManager>

• the makeMap function is used to make a map for a given key

  Parameters

  • docs: any[]

    The docs to make the map for.

  Returns Map<string, PineDocsManager>

  The map.

mergeDocs

• mergeDocs(currentDocs, newDocs): any[]

• Helper function to merge new docs into current docs

  Parameters

  • currentDocs: any[]

    The current docs.

  • newDocs: any[]

    The new docs.

  Returns any[]

  The merged docs.

setDocs

• setDocs(newDocs, key): void

• the setDocs function is used to set the docs for a given key

  Parameters

  • newDocs: any

    The new docs to set.

  • key: string

    The key to set the docs for.

  Returns void

  The key.

setImportDocs

• setImportDocs(docs): void

• the setImportsDocs function is used to sed the imports key of the response object

  Parameters

  • docs: any

    The docs to set.

  Returns void

  The key.

setParsed

• setParsed(docs, keyType): void

• the setParsed function is used to set the parsed docs for a given key

  Parameters

  • docs: any[]

    The docs to set.

  • keyType: string

    The key type to set the docs for.

  Returns void

setSwitch

• setSwitch(key, docs): void

• Sets the typedocs for the setSwitch function.

  Parameters

  • key: string

    The key to switch on.

  • docs: any

    The docs to set.

  Returns void

  The typedocs for the setSwitch function.