@types/ibm-openapi-validator - npm Package Compare versions

Comparing version 0.15.0 to 0.15.1

ibm-openapi-validator/index.d.ts

 // Type definitions for ibm-openapi-validator 0.15
 // Project: https://github.com/IBM/openapi-validator#readme
-// Definitions by: Rifa Achrinza <https://github.com/DefinitelyTyped>
+// Definitions by: Rifa Achrinza <https://github.com/achrinza>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -5,0 +5,0 @@ // TypeScript Version: 3.0

ibm-openapi-validator/package.json

 {
     "name": "@types/ibm-openapi-validator",
-    "version": "0.15.0",
+    "version": "0.15.1",
     "description": "TypeScript definitions for ibm-openapi-validator",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ibm-openapi-validator",
     "license": "MIT",
@@ -9,4 +10,4 @@ "contributors": [
             "name": "Rifa Achrinza",
-            "url": "https://github.com/DefinitelyTyped",
-            "githubUsername": "DefinitelyTyped"
+            "url": "https://github.com/achrinza",
+            "githubUsername": "achrinza"
         }
@@ -23,4 +24,4 @@ ],
     "dependencies": {},
-    "typesPublisherContentHash": "1fb960408153d023506e29c4aa941f5366e45d0aa4bf4b13456865bae194cb18",
-    "typeScriptVersion": "3.0"
+    "typesPublisherContentHash": "ca73dc92a36ba3009dd39d662317db68da167b307ca0d0fa322ed83ed0bec174",
+    "typeScriptVersion": "3.6"
 }

ibm-openapi-validator/README.md

@@ -9,5 +9,39 @@ # Installation
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ibm-openapi-validator.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ibm-openapi-validator/index.d.ts)
+````ts
+// Type definitions for ibm-openapi-validator 0.15
+// Project: https://github.com/IBM/openapi-validator#readme
+// Definitions by: Rifa Achrinza <https://github.com/achrinza>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 3.0
 
+interface validatorResultItem {
+    path: string;
+    message: string;
+}
+
+interface validatorResult {
+    errors: [] | [ validatorResultItem ];
+    warnings: [] | [ validatorResultItem ];
+}
+
+/**
+ * @default false
+ */
+type validatorParameterDefaultMode = boolean;
+
+/**
+ * OpenAPI document validator
+ * @param openApiDoc - OpenAPI document object
+ * @param defaultMode - If set to true, the validator will ignore the .validaterc file and will use the [configuration defaults](https://github.com/IBM/openapi-validator#default-values).
+ * @returns Validation results
+ */
+declare function validator(openApiDoc: {[property: string]: any}, defaultMode?: validatorParameterDefaultMode): Promise<validatorResult>;
+
+export = validator;
+
+````
+
 ### Additional Details
- * Last updated: Sat, 23 Nov 2019 02:42:24 GMT
+ * Last updated: Thu, 08 Jul 2021 22:41:05 GMT
  * Dependencies: none
@@ -17,2 +51,2 @@ * Global values: none
 # Credits
-These definitions were written by Rifa Achrinza (https://github.com/DefinitelyTyped).
+These definitions were written by [Rifa Achrinza](https://github.com/achrinza).

No alert changes

Improved metrics

Total package byte prevSize

4656

increased by33.64%

Number of lines in readme file

51

increased by200%

No dependency changes