Function pluginOptions

  • pluginOptions(app): {
        options: (() => {
            customDescription: undefined | string;
            customTitle: undefined | string;
            favicon: undefined | string;
            footerDate: boolean;
            footerLastModified: boolean;
            footerTime: boolean;
            footerTypedocVersion: boolean;
            hideGenerator: boolean;
            outDir: undefined | string;
        });
    }

  • Parameters

    • app: Application

    Returns {
        options: (() => {
            customDescription: undefined | string;
            customTitle: undefined | string;
            favicon: undefined | string;
            footerDate: boolean;
            footerLastModified: boolean;
            footerTime: boolean;
            footerTypedocVersion: boolean;
            hideGenerator: boolean;
            outDir: undefined | string;
        });
    }

    • options: (() => {
          customDescription: undefined | string;
          customTitle: undefined | string;
          favicon: undefined | string;
          footerDate: boolean;
          footerLastModified: boolean;
          footerTime: boolean;
          footerTypedocVersion: boolean;
          hideGenerator: boolean;
          outDir: undefined | string;
      })
        • (): {
              customDescription: undefined | string;
              customTitle: undefined | string;
              favicon: undefined | string;
              footerDate: boolean;
              footerLastModified: boolean;
              footerTime: boolean;
              footerTypedocVersion: boolean;
              hideGenerator: boolean;
              outDir: undefined | string;
          }

        • Returns {
              customDescription: undefined | string;
              customTitle: undefined | string;
              favicon: undefined | string;
              footerDate: boolean;
              footerLastModified: boolean;
              footerTime: boolean;
              footerTypedocVersion: boolean;
              hideGenerator: boolean;
              outDir: undefined | string;
          }

          • customDescription: undefined | string
          • customTitle: undefined | string
          • favicon: undefined | string
          • footerDate: boolean
          • footerLastModified: boolean
          • footerTime: boolean
          • footerTypedocVersion: boolean
          • hideGenerator: boolean
          • outDir: undefined | string

Settings

Member Visibility