mirror of
https://github.com/FlipsideCrypto/DefinitelyTyped.git
synced 2026-02-06 19:07:08 +00:00
[@types/apidoc] Add apidoc typings (#44609)
* [@types/apidoc] Add apidoc typings * Fix default export
This commit is contained in:
parent
3ad3850465
commit
492b0ea590
22
types/apidoc/apidoc-tests.ts
Normal file
22
types/apidoc/apidoc-tests.ts
Normal file
@ -0,0 +1,22 @@
|
||||
import { createDoc } from 'apidoc';
|
||||
|
||||
const apidocOutput = createDoc({
|
||||
dest: '',
|
||||
template: '',
|
||||
templateSingleFile: '',
|
||||
debug: true,
|
||||
single: true,
|
||||
silent: true,
|
||||
verbose: true,
|
||||
simulate: true,
|
||||
parse: true,
|
||||
colorize: true,
|
||||
markdown: true,
|
||||
config: '',
|
||||
apiprivate: true,
|
||||
encoding: '',
|
||||
});
|
||||
|
||||
if (typeof apidocOutput !== 'boolean') {
|
||||
const { data, project } = apidocOutput;
|
||||
}
|
||||
23
types/apidoc/index.d.ts
vendored
Normal file
23
types/apidoc/index.d.ts
vendored
Normal file
@ -0,0 +1,23 @@
|
||||
// Type definitions for apidoc 0.22
|
||||
// Project: https://github.com/apidoc/apidoc
|
||||
// Definitions by: rigwild <https://github.com/rigwild>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
|
||||
export interface DocOptions {
|
||||
dest?: string;
|
||||
template?: string;
|
||||
templateSingleFile?: string;
|
||||
debug?: boolean;
|
||||
single?: boolean;
|
||||
silent?: boolean;
|
||||
verbose?: boolean;
|
||||
simulate?: boolean;
|
||||
parse?: boolean;
|
||||
colorize?: boolean;
|
||||
markdown?: boolean;
|
||||
config?: string;
|
||||
apiprivate?: boolean;
|
||||
encoding?: string;
|
||||
}
|
||||
|
||||
export function createDoc(options: DocOptions): boolean | { data: Record<string, any>; project: Record<string, any> };
|
||||
23
types/apidoc/tsconfig.json
Normal file
23
types/apidoc/tsconfig.json
Normal file
@ -0,0 +1,23 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"lib": [
|
||||
"es6"
|
||||
],
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"strictFunctionTypes": true,
|
||||
"strictNullChecks": true,
|
||||
"baseUrl": "../",
|
||||
"typeRoots": [
|
||||
"../"
|
||||
],
|
||||
"types": [],
|
||||
"noEmit": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"apidoc-tests.ts"
|
||||
]
|
||||
}
|
||||
1
types/apidoc/tslint.json
Normal file
1
types/apidoc/tslint.json
Normal file
@ -0,0 +1 @@
|
||||
{ "extends": "dtslint/dt.json" }
|
||||
Loading…
Reference in New Issue
Block a user