Skip to main content

​
convertApiItem

​
Summary

Convert an API item to template data

​
Signature

convertApiItem(apiItem: ApiItem, options: {
        pageTitle: string;
        pageDescription: string;
        pageIcon: string;
        breadcrumb: Array<{
            name: string;
            path?: string;
        }>;
        navigation?: {
            id: string;
            title: string;
            group?: string;
        };
        getLinkFilenameForApiItem: (apiItem: ApiItem) => string | undefined;
    }): ITemplateData;

​
Parameters

​
apiItem

Type:ApiItem

​
options

Type: 
{
        pageTitle: string;
        pageDescription: string;
        pageIcon: string;
        breadcrumb: Array<{
            name: string;
            path?: string;
        }>;
        navigation?: {
            id: string;
            title: string;
            group?: string;
        };
        getLinkFilenameForApiItem: (apiItem: ApiItem) => string | undefined;
    }

​
Returns

Type:ITemplateData Convert an API item to template data