Equation Citator v1.3.7 Documentation
    Preparing search index...

    Cache for parsed callouts/quotes in markdown files Stores callout data including type, tag, content, and line range

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    cache: Map<string, CachedData<CalloutMatch>> = ...
    forceUpdateTimeout: number
    isDestroyed: boolean = false
    maxCacheSize: number = 30
    plugin: default

    Methods

    • Get statistcs about the cache

      Returns { newestEntry?: number; oldestEntry?: number; size: number }

    • Find a specific callout by its tag in a file

      Parameters

      • sourcePath: string

        Path to the file

      • tag: string

        The tag to search for (without prefix, e.g., "1.1" not "table:1.1")

      Returns Promise<CalloutMatch | undefined>

      The matched CalloutMatch or undefined

    • Find callouts by type in a file

      Parameters

      • sourcePath: string

        Path to the file

      • type: string

        The type to filter by (e.g., "table", "thm", "def")

      Returns Promise<CalloutMatch[]>

      Array of CalloutMatch objects of the specified type

    • Get callouts for a specific file

      Parameters

      • sourcePath: string

        Path to the file

      Returns Promise<CalloutMatch[] | undefined>

      Array of CalloutMatch objects