From f1b358066b10b8baa3cc9ccb042ed25397d1bb33 Mon Sep 17 00:00:00 2001
From: Adam Zerella <adamzerella@users.noreply.github.com>
Date: Thu, 14 Feb 2019 23:27:40 +1100
Subject: [PATCH] Moved everything into unified namespace

Added basic function tests
---
 types/jsdoc-to-markdown/index.d.ts            | 18 +++++++--------
 .../jsdoc-to-markdown-tests.ts                | 23 +++++++++++++++++++
 2 files changed, 32 insertions(+), 9 deletions(-)

diff --git a/types/jsdoc-to-markdown/index.d.ts b/types/jsdoc-to-markdown/index.d.ts
index 2c96a07f28..78b4d7d045 100644
--- a/types/jsdoc-to-markdown/index.d.ts
+++ b/types/jsdoc-to-markdown/index.d.ts
@@ -4,16 +4,16 @@
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 // TypeScript Version: 2.9
 
-export enum StyleListFormat { "none", "grouped", "table", "dl" }
-export enum RenderListFormat { "list", "table" }
-export enum MemberIndexFormat { "grouped", "list" }
+export type StyleListFormat = "none" | "grouped" | "table" | "dl";
+export type RenderListFormat = "list" | "table";
+export type MemberIndexFormat = "grouped" | "list";
 
 export interface RenderOptions {
     /**
      * Raw template data to use. Useful when you already have template data, obtained from .getTemplateData.
      * Either files, source or data must be supplied.
      */
-    data: object[];
+    data?: object[];
     /**
      * The template the supplied documentation will be rendered into.
      * Use the default or supply your own template for full control over the output.
@@ -77,7 +77,7 @@ export interface JsdocOptions {
      * By default results are cached to speed up repeat invocations.
      * Set to true to disable this.
      */
-    noCache: boolean;
+    noCache?: boolean;
     /**
      * One or more filenames to process.
      * Accepts globs (e.g. *.js). Either files, source or data must be supplied.
@@ -87,23 +87,23 @@ export interface JsdocOptions {
      * A string containing source code to process.
      * Either files, source or data must be supplied.
      */
-    source: string;
+    source?: string;
     /**
      * The path to the jsdoc configuration file.
      *  Default: path/to/jsdoc/conf.json.
      */
-    configure: string;
+    configure?: string;
 }
 
 export class JsdocToMarkdown {
     /**
      * Returns markdown documentation from jsdoc-annoted source code.
      */
-    render(options: RenderOptions): Promise<string>;
+    render(options: RenderOptions|JsdocOptions): Promise<string>;
     /**
      * Sync version of render.
      */
-    renderSync(options: RenderOptions): string;
+    renderSync(options: RenderOptions|JsdocOptions): string;
     /**
      * Returns the template data (jsdoc-parse output) which is fed into the output template (dmd).
      */
diff --git a/types/jsdoc-to-markdown/jsdoc-to-markdown-tests.ts b/types/jsdoc-to-markdown/jsdoc-to-markdown-tests.ts
index e69de29bb2..e37d899bd4 100644
--- a/types/jsdoc-to-markdown/jsdoc-to-markdown-tests.ts
+++ b/types/jsdoc-to-markdown/jsdoc-to-markdown-tests.ts
@@ -0,0 +1,23 @@
+import { JsdocToMarkdown, StyleListFormat } from "jsdoc-to-markdown";
+
+const jsdoc2md = new JsdocToMarkdown();
+
+const JsdocDataOptions = {
+    files: "file.js"
+};
+
+const RenderOptions = {
+    data: [],
+    plugin: "",
+    helper: [""],
+    moduleIndexFormat: "table" as StyleListFormat
+};
+
+jsdoc2md.render(JsdocDataOptions);
+jsdoc2md.renderSync(RenderOptions);
+jsdoc2md.getTemplateData(JsdocDataOptions);
+jsdoc2md.getTemplateDataSync(JsdocDataOptions);
+jsdoc2md.getJsdocData(JsdocDataOptions);
+jsdoc2md.getJsdocDataSync(JsdocDataOptions);
+jsdoc2md.clear();
+jsdoc2md.getNamepaths(JsdocDataOptions);