comment-parser - npm Package Compare versions

Comparing version 0.5.2 to 0.5.3

CHANGELOG.md

@@ -0,1 +1,4 @@
+# v0.5.3
+- corrected TypeScript definitions
+
 # v0.5.2
@@ -2,0 +5,0 @@ - added TypeScript definitions

index.d.ts

@@ -5,24 +5,26 @@ // Type definitions for comment-parser
 
-interface Comment {
-  tags: Tag[];
-  line: number;
-  description: string;
-  source: string;
+declare namespace CommentParser {
+  export interface Comment {
+    tags: Tag[];
+    line: number;
+    description: string;
+    source: string;
+  }
+  export interface Tag {
+    tag: string;
+    name: string;
+    optional: boolean;
+    type: string;
+    description: string;
+    line: number;
+    source: string;
+  }
+  export interface Options {
+    parsers?: [(str: string, data: any) => { source: string, data: any }];
+    dotted_names?: boolean;
+  }
 }
-interface Tag {
-  tag: string;
-  name: string;
-  optional: boolean;
-  type: string;
-  description: string;
-  line: number;
-  source: string;
-}
-interface Options {
-  parsers?: [(str: string, data: any) => { source: string, data: any }];
-  dotted_names?: boolean;
-}
 
-declare function parse(str: string, opts?: Options): [Comment];
+declare function parse(str: string, opts?: CommentParser.Options): [CommentParser.Comment];
 
 export = parse;

package.json

 {
   "name": "comment-parser",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "description": "Generic JSDoc-like comment parser. ",
   "main": "index.js",
+  "types": "index.d.ts",
   "directories": {
@@ -7,0 +8,0 @@ "test": "tests"

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

48969

increased by0.52%

Lines of code

1508

increased by0.13%

No dependency changes