is-my-json-valid - npm Package Compare versions

Comparing version 2.17.2 to 2.18.0

package.json

 {
   "name": "is-my-json-valid",
-  "version": "2.17.2",
+  "version": "2.18.0",
   "description": "A JSONSchema validator that uses code generation to be extremely fast",
@@ -15,6 +15,7 @@ "main": "index.js",
     "safe-regex": "^1.1.0",
-    "tape": "^2.13.4"
+    "tape": "^2.13.4",
+    "typescript": "^3.0.1"
   },
   "scripts": {
-    "test": "tape test/*.js"
+    "test": "tape test/*.js && tsc"
   },
@@ -21,0 +22,0 @@ "repository": {

README.md

@@ -222,4 +222,41 @@ # is-my-json-valid
 
+## TypeScript support
+
+This library ships with TypeScript typings. They are still early on and not perfect at the moment, but should hopefully handle the most common cases. If you find anything that doesn't work, please open an issue and we'll try to solve it.
+
+The typings are using `unknown` and thus require TypeScript 3.0 or later.
+
+Here is a quick sample of usage together with express:
+
+```typescript
+import createError = require('http-errors')
+import createValidator = require('is-my-json-valid')
+import { Request, Response, NextFunction } from 'express'
+
+const personValidator = createValidator({
+  type: 'object',
+  properties: {
+    name: { type: 'string' },
+    age: { type: 'number' },
+  },
+  required: [
+    'name'
+  ]
+})
+
+export function post (req: Request, res: Response, next: NextFunction) {
+  // Here req.body is typed as: any
+
+  if (!personValidator(req.body)) {
+    throw createError(400, { errors: personValidator.errors })
+  }
+
+  // Here req.body is typed as: { name: string, age: number | undefined }
+}
+```
+
+As you can see, the typings for is-my-json-valid will contruct an interface from the schema passed in. This allows you to work with your incoming json body in a type safe way.
+
 ## License
 
 MIT

No alert changes

Improved metrics

Total package byte prevSize

120794

increased by6.54%

Number of package files

49

increased by8.89%

Lines of code

3763

increased by5.47%

Number of lines in readme file

262

increased by16.44%

Worsened metrics

Dev dependency count

3

increased by50%

No dependency changes