Class ApiConsoleModule

constructor

• new ApiConsoleModule(config?: {
      listen?: boolean;
      markdown?: string;
      markdownFile?: string;
      path?: string;
  }): ApiConsoleModule

• Parameters

  • Optional config: {
        listen?: boolean;
        markdown?: string;
        markdownFile?: string;
        path?: string;
    }

    • Optional listen?: boolean

      Description

      If true serves the application at given URL path.

    • Optional markdown?: string

      Description

      Markdown to display at the overview page.

    • Optional markdownFile?: string

      Description

      Path to a markdown file to display at the overview page.

    • Optional path?: string

  Returns ApiConsoleModule