DocsIndexSource

fun interface DocsIndexSource

Source of pre-extracted documentation index payloads (DOCS_INDEX_FILE_NAME), abstracting away how the indexes are located and read: from the installation's docs directory on the JVM, or fetched over the network in browser deployments.

Sources are used as cache keys by com.quarkdown.lsp.cache.CacheableFunctionCatalogue, so implementations should provide value equality.

Inheritors

Functions

Link copied to clipboard
abstract fun readIndexes(): List<String>