From 5b87c9dd82a7f173f623c82a6ec345cd8ea5369e Mon Sep 17 00:00:00 2001 From: "Adam A. Zerella" Date: Wed, 13 Feb 2019 15:44:24 +1100 Subject: [PATCH] Added starter files --- types/jsdoc-to-markdown/index.d.ts | 41 +++++++++++++++++++ .../jsdoc-to-markdown-tests.ts | 0 types/jsdoc-to-markdown/tsconfig.json | 25 +++++++++++ types/jsdoc-to-markdown/tslint.json | 3 ++ 4 files changed, 69 insertions(+) create mode 100644 types/jsdoc-to-markdown/index.d.ts create mode 100644 types/jsdoc-to-markdown/jsdoc-to-markdown-tests.ts create mode 100644 types/jsdoc-to-markdown/tsconfig.json create mode 100644 types/jsdoc-to-markdown/tslint.json diff --git a/types/jsdoc-to-markdown/index.d.ts b/types/jsdoc-to-markdown/index.d.ts new file mode 100644 index 0000000000..3cce87a6e6 --- /dev/null +++ b/types/jsdoc-to-markdown/index.d.ts @@ -0,0 +1,41 @@ +// Type definitions for jsdoc-to-markdown 4.0 +// Project: https://github.com/jsdoc2md/jsdoc-to-markdown +// Definitions by: Adam Zerella +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.9 + +interface RenderOptions { + data: object[]; + template?: string; + headingDepth?: number; + exampleLang?: string; + plugin?: string|string[]; + helper?: string|string[]; + partial?: string|string[]; + nameFormat?: string; + noGfm?: boolean; + seperators?: boolean; + moduleIndexFormat?: string; + globalIndexFormat?: string; // @todo + paramListFormat?: string; // @todo + propertyListFormat?: string; // @todo + memberIndexFormat?: string; // @todo +} + +interface JsdocOptions { + noCache: boolean; + files: string|string[]; + source: string; + configure: string; +} + +declare class JsdocToMarkdown { + render(options: RenderOptions): Promise; + renderSync(options: RenderOptions): string; + getTemplateData(options: JsdocOptions): object[]; + getTemplateDataSync(options: JsdocOptions): object[]; + getJsdocData(options: JsdocOptions): object[]; + getJsdocDataSync(options: JsdocOptions): object[]; + clear(): Promise; + getNamepaths(options: JsdocOptions): object; +} diff --git a/types/jsdoc-to-markdown/jsdoc-to-markdown-tests.ts b/types/jsdoc-to-markdown/jsdoc-to-markdown-tests.ts new file mode 100644 index 0000000000..e69de29bb2 diff --git a/types/jsdoc-to-markdown/tsconfig.json b/types/jsdoc-to-markdown/tsconfig.json new file mode 100644 index 0000000000..eabb42ab3b --- /dev/null +++ b/types/jsdoc-to-markdown/tsconfig.json @@ -0,0 +1,25 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [ + + ], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "jsdoc-to-markdown-tests.ts" + ] +} diff --git a/types/jsdoc-to-markdown/tslint.json b/types/jsdoc-to-markdown/tslint.json new file mode 100644 index 0000000000..e60c15844f --- /dev/null +++ b/types/jsdoc-to-markdown/tslint.json @@ -0,0 +1,3 @@ +{ + "extends": "dtslint/dt.json" +} \ No newline at end of file