Method getParsedIndexFile

src/helpViewer/packages.ts:347–371

(path: string)

    // retrieve and parse an index file
    // (either list of all packages, or documentation entries of a package)
    private async getParsedIndexFile(path: string): Promise<IndexEntry[]|undefined> {

        let indexItems = this.getCachedIndexFile(path);

        // only read and parse file if not cached yet
        if(!indexItems){
            const helpFile = await this.rHelp.getHelpFileForPath(path, false);
            if(!helpFile?.html){
                // set missing files to null
                indexItems = undefined;
            } else{
                // parse and cache file
                indexItems = parseIndexFile(helpFile.html);
            }
            void this.updateCachedIndexFile(path, indexItems);
        }

        // return cache entry. make new array to avoid messing with the cache
        let ret: IndexEntry[] | undefined = undefined;
        if(indexItems){
            ret = [];
            ret.push(...indexItems);
        }
        return ret;
    }
}