Class PineHoverHelpers

constructor

• new PineHoverHelpers(): PineHoverHelpers

• Returns PineHoverHelpers

Static mapArrayMatrixNew

Static mapArrayMatrixType

Static checkCache

• checkCache(key, regexId, isMethod, hoverCache): any

• Checks the cache for a specific key.

  Parameters

  • key: string

    The cache key.

  • regexId: string

    The regex ID.

  • isMethod: boolean

    Indicates if the key is a method.

  • hoverCache: Map<[string, string], any>

    The hover cache.

  Returns any

  The cached value if found, otherwise undefined.

Static formRegexGetDocs

• formRegexGetDocs(...regexId): Promise<undefined | [undefined | string, any]>

• Forms a regular expression and retrieves documentation based on the provided regex IDs.

  Parameters

  • Rest ...regexId: string[]

    The regex IDs.

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

  A promise that resolves to an array containing the hover regex and the documentation map.

Static includesHelper

• includesHelper(type, thisType): boolean

• Checks if a type includes a specific type.

  Parameters

  • type: string[]

    The type to check.

  • thisType: string

    The type to check for.

  Returns boolean

  True if the type includes the specific type, otherwise false.

Static regexReplace

• regexReplace(input): string

• Replaces special characters in a string with their escaped counterparts.

  Parameters

  • input: string

    The input string.

  Returns string

  The string with escaped characters.

Static replaceAlias

• replaceAlias(input): string

• Replaces alias characters in a string.

  Parameters

  • input: string

    The input string.

  Returns string

  The string with replaced aliases.

Static replaceMapArrayMatrix

• replaceMapArrayMatrix(syntaxContentKey, mapArrayMatrix): string

• Replaces map, array, and matrix types in a syntax content key.

  Parameters

  • syntaxContentKey: string

    The syntax content key.

  • mapArrayMatrix: string

    The replacement string for map, array, and matrix.

  Returns string

  The syntax content key with replaced map, array, and matrix types.

Static replaceNamespace

• replaceNamespace(syntax, namespace, isMethod?): string

• Replaces the namespace in a syntax string.

  Parameters

  • syntax: string

    The syntax string.

  • namespace: undefined | string

    The namespace to replace.

  • isMethod: boolean = false

  Returns string

  The syntax string with replaced namespace.