Method getTopics

src/helpViewer/packages.ts:278–343

(pkgName: string, summarize: boolean = false)

    // parses a package's index file to produce a list of help topics
    // highlights ths 'home' topic and adds entries for the package index and DESCRIPTION file
    public async getTopics(pkgName: string, summarize: boolean = false): Promise<Topic[] | undefined> {

        const indexEntries = await this.getParsedIndexFile(`/library/${pkgName}/html/00Index.html`);

        if(!indexEntries){
            return undefined;
        }

        const topics: TopicExtra[] = indexEntries.map(v => {
            const topic: TopicExtra = {
                name: v.name,
                description: v.description,
                href: v.href || v.name,
                type: TopicType.NORMAL, //replaced below
                helpPath: '' // replaced below
            };

            topic.type = (topic.name === `${pkgName}-package` ? TopicType.HOME : TopicType.NORMAL);

            topic.helpPath = (
                pkgName === 'doc' ?
                    `/doc/html/${topic.href}` :
                    `/library/${pkgName}/html/${topic.href}`
            );
            return topic;
        });

        const ind = topics.findIndex(v => v.type === TopicType.HOME);
        let homeTopic: TopicExtra | undefined = undefined;
        if(ind >= 0){
            homeTopic = topics.splice(ind, 1)[0];
        }

        const indexTopic: TopicExtra = {
            name: 'Index',
            description: '',
            href: '00Index.html',
            helpPath: `/library/${pkgName}/html/00Index.html`,
            type: TopicType.INDEX
        };

        const descriptionTopic: TopicExtra = {
            name: 'DESCRIPTION',
            description: '',
            href: '../DESCRIPTION',
            helpPath: `/library/${pkgName}/DESCRIPTION`,
            type: TopicType.META
        };

        topics.unshift(indexTopic, descriptionTopic);
        if(homeTopic){
            topics.unshift(homeTopic);
        }

        const ret = (summarize ? summarizeTopics(topics) : topics);

        ret.sort((a, b) => {
            if(a.type === b.type){