mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
Added starter files
This commit is contained in:
parent
d77c47c753
commit
5b87c9dd82
41
types/jsdoc-to-markdown/index.d.ts
vendored
Normal file
41
types/jsdoc-to-markdown/index.d.ts
vendored
Normal file
@ -0,0 +1,41 @@
|
||||
// Type definitions for jsdoc-to-markdown 4.0
|
||||
// Project: https://github.com/jsdoc2md/jsdoc-to-markdown
|
||||
// Definitions by: Adam Zerella <https://github.com/adamzerella>
|
||||
// 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<string>;
|
||||
renderSync(options: RenderOptions): string;
|
||||
getTemplateData(options: JsdocOptions): object[];
|
||||
getTemplateDataSync(options: JsdocOptions): object[];
|
||||
getJsdocData(options: JsdocOptions): object[];
|
||||
getJsdocDataSync(options: JsdocOptions): object[];
|
||||
clear(): Promise<void>;
|
||||
getNamepaths(options: JsdocOptions): object;
|
||||
}
|
||||
0
types/jsdoc-to-markdown/jsdoc-to-markdown-tests.ts
Normal file
0
types/jsdoc-to-markdown/jsdoc-to-markdown-tests.ts
Normal file
25
types/jsdoc-to-markdown/tsconfig.json
Normal file
25
types/jsdoc-to-markdown/tsconfig.json
Normal file
@ -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"
|
||||
]
|
||||
}
|
||||
3
types/jsdoc-to-markdown/tslint.json
Normal file
3
types/jsdoc-to-markdown/tslint.json
Normal file
@ -0,0 +1,3 @@
|
||||
{
|
||||
"extends": "dtslint/dt.json"
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user