@types/apidoc - npm Package Compare versions

Comparing version 0.22.2 to 0.22.3

apidoc/index.d.ts

@@ -15,15 +15,15 @@ // Type definitions for apidoc 0.22
 export interface DocOptions {
-    excludeFilters?: string[];
-    includeFilters?: string[];
-    src?: string;
-    dest?: string;
-    template?: string;
-    templateSingleFile?: string;
-    config?: string;
-    apiprivate?: boolean;
-    verbose?: boolean;
-    single?: boolean;
-    debug?: boolean;
-    parse?: boolean;
-    colorize?: boolean;
+    excludeFilters?: string[] | undefined;
+    includeFilters?: string[] | undefined;
+    src?: string | undefined;
+    dest?: string | undefined;
+    template?: string | undefined;
+    templateSingleFile?: string | undefined;
+    config?: string | undefined;
+    apiprivate?: boolean | undefined;
+    verbose?: boolean | undefined;
+    single?: boolean | undefined;
+    debug?: boolean | undefined;
+    parse?: boolean | undefined;
+    colorize?: boolean | undefined;
     filters?: Record<string, string> | {
@@ -33,3 +33,3 @@ [keys: string]: {
         }
-    };
+    } | undefined;
     languages?: Record<string, string> | {
@@ -40,3 +40,3 @@ [language: string]: {
         }
-    };
+    } | undefined;
     parsers?: Record<string, string> | {
@@ -49,18 +49,18 @@ parse: (content: string, source: string, messages: string) => {
         path: string;
-        getGroup?: () => string;
-        markdownFields?: string[];
-        markdownRemovePTags?: string[];
-    };
+        getGroup?: (() => string) | undefined;
+        markdownFields?: string[] | undefined;
+        markdownRemovePTags?: string[] | undefined;
+    } | undefined;
     workers?: Record<string, string> | {
         [keys: string]: any;
-    };
-    silent?: boolean;
-    simulate?: boolean;
-    markdown?: boolean;
-    lineEnding?: string;
-    encoding?: string;
-    copyDefinitions?: boolean;
-    filterBy?: string | string[];
+    } | undefined;
+    silent?: boolean | undefined;
+    simulate?: boolean | undefined;
+    markdown?: boolean | undefined;
+    lineEnding?: string | undefined;
+    encoding?: string | undefined;
+    copyDefinitions?: boolean | undefined;
+    filterBy?: string | string[] | undefined;
 }
 
 export function createDoc(options: DocOptions): boolean | { data: Record<string, any>; project: Record<string, any> };

apidoc/package.json

 {
     "name": "@types/apidoc",
-    "version": "0.22.2",
+    "version": "0.22.3",
     "description": "TypeScript definitions for apidoc",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/apidoc",
     "license": "MIT",
@@ -27,4 +28,4 @@ "contributors": [
     "dependencies": {},
-    "typesPublisherContentHash": "91d385feeac58c42d709d9e1b40745748b61e984b793a37bbbf133bd43db1944",
-    "typeScriptVersion": "3.0"
+    "typesPublisherContentHash": "0731df9d79c9f90f6afc4e45eb6c0aff248deb1a431633d2d0966508a0070c2b",
+    "typeScriptVersion": "3.6"
 }

apidoc/README.md

@@ -9,5 +9,71 @@ # Installation
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/apidoc.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/apidoc/index.d.ts)
+````ts
+// Type definitions for apidoc 0.22
+// Project: https://github.com/apidoc/apidoc
+// Definitions by: rigwild <https://github.com/rigwild>
+//                 hoonga <https://github.com/hoonga>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
+export interface ParsedFile {
+    filename: string;
+    extension: string;
+    src: string;
+    blocks: Array<{ global: any; local: any; }>;
+}
+
+export interface DocOptions {
+    excludeFilters?: string[] | undefined;
+    includeFilters?: string[] | undefined;
+    src?: string | undefined;
+    dest?: string | undefined;
+    template?: string | undefined;
+    templateSingleFile?: string | undefined;
+    config?: string | undefined;
+    apiprivate?: boolean | undefined;
+    verbose?: boolean | undefined;
+    single?: boolean | undefined;
+    debug?: boolean | undefined;
+    parse?: boolean | undefined;
+    colorize?: boolean | undefined;
+    filters?: Record<string, string> | {
+        [keys: string]: {
+            postFilter: (parsedFiles: ParsedFile[], parsedFilenames: string[]) => void
+        }
+    } | undefined;
+    languages?: Record<string, string> | {
+        [language: string]: {
+            docBlocksRegExp: RegExp;
+            inlineRegExp: RegExp;
+        }
+    } | undefined;
+    parsers?: Record<string, string> | {
+        parse: (content: string, source: string, messages: string) => {
+            name: string;
+            title: string;
+            description: string;
+        };
+        path: string;
+        getGroup?: (() => string) | undefined;
+        markdownFields?: string[] | undefined;
+        markdownRemovePTags?: string[] | undefined;
+    } | undefined;
+    workers?: Record<string, string> | {
+        [keys: string]: any;
+    } | undefined;
+    silent?: boolean | undefined;
+    simulate?: boolean | undefined;
+    markdown?: boolean | undefined;
+    lineEnding?: string | undefined;
+    encoding?: string | undefined;
+    copyDefinitions?: boolean | undefined;
+    filterBy?: string | string[] | undefined;
+}
+
+export function createDoc(options: DocOptions): boolean | { data: Record<string, any>; project: Record<string, any> };
+
+````
+
 ### Additional Details
- * Last updated: Sun, 02 Aug 2020 11:31:14 GMT
+ * Last updated: Wed, 07 Jul 2021 21:44:26 GMT
  * Dependencies: none
@@ -14,0 +80,0 @@ * Global values: none

Fixed alerts

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6961

62.41%

Number of low quality alerts

1

-50%

Number of lines in readme file

83

388.24%

No dependency changes