Interface PluginInterface

lib/interface.d.ts:15–117

 * PluginInterface
 */
export interface PluginInterface {

    /**
     * Return  section elements that is going to be
     * inserted into the side navigation bar.
     * 
     * @example plain javascript:
     * [
     *  {
     *      title: 'Schema',
     *      items: [
     *          {
     *              text: 'Query',
     *              href: './query.doc.html',
     *              isActive: false
     *          },
     *          // ...
     *  }
     *  // ...
     * ]
     * 
     * @example with graphdoc utilities:
     * import { NavigationSection, NavigationItem } from 'graphdoc/lib/utility';
     * 
     * [
     *  new NavigationSection('Schema', [
     *      new NavigationItem('Query', ./query.doc.html', false)
     *  ]),
     *  // ...
     * ]
     * 
     * @param {string} [buildForType] -
     *  the name of the element for which the navigation section is being generated,
     *  if it is `undefined it means that the index of documentation is being generated
     */
    getNavigations?: (buildForType?: string) => NavigationSectionInterface[] | PromiseLike<NavigationSectionInterface[]>;

    /**
     * Return  section elements that is going to be
     * inserted into the main section.
     * 
     * @example plain javascript:
     * [
     *  {
     *      title: 'GraphQL Schema definition',
     *      description: 'HTML'
     *  },
     *  // ...
     * ]
     * 
     * @example with graphdoc utilities:
     * import { DocumentSection } from 'graphdoc/lib/utility';
     * 
     * [
     *  new DocumentSection('GraphQL Schema definition', 'HTML'),
     *  // ...
     * ]
     *