Added shallow option to exclude array items and object properties from the results

Author: ericallam

README.md

@@ -138,6 +138,18 @@ Gives the result
 }
 ```
 
+If you don't want or need the `properties` or `items` inferred you can pass the `shallow: true` option to `inferType`
+
+```js
+inferType(
+  [
+    { id: "1", email: "[email protected]" },
+    { id: "2", email: "[email protected]" },
+  ],
+  { shallow: true }
+); // => { name: "array" }
+```
+
 ### Strings
 
 JSON Infer Types will also recognize certain string formats and include that information in the result, for example if the string is a `URI`:

src/@types.ts

@@ -110,12 +110,12 @@ export type JSONStringType = {
 
 export type JSONObjectType = {
   name: "object";
-  properties: Record<string, JSONValueType>;
+  properties?: Record<string, JSONValueType>;
 };
 
 export type JSONArrayType = {
   name: "array";
-  items: JSONValueType | JSONValueType[];
+  items?: JSONValueType | JSONValueType[];
 };
 
 export type JSONValueType =

src/index.ts

@@ -4,7 +4,16 @@ import { JSONValueType, JSONStringFormat } from "./@types";
 
 import * as formats from "./formats";
 
-export function inferType(value: any): JSONValueType {
+type InferTypeOptions = {
+  shallow?: boolean;
+};
+
+export function inferType(
+  value: any,
+  options?: InferTypeOptions
+): JSONValueType {
+  const opts = Object.assign({}, { shallow: false }, options);
+
   if (value === null) {
     return { name: "null" };
   }
@@ -27,7 +36,13 @@ export function inferType(value: any): JSONValueType {
 
   if (typeof value === "object") {
     if (Array.isArray(value)) {
-      const itemTypes = value.map(inferType);
+      if (opts.shallow) {
+        return {
+          name: "array",
+        };
+      }
+
+      const itemTypes = value.map((item) => inferType(item, opts));
       const uniqTypes = uniqWith(itemTypes, isEqual);
 
       if (uniqTypes.length === 1) {
@@ -43,6 +58,12 @@ export function inferType(value: any): JSONValueType {
       };
     }
 
+    if (opts.shallow) {
+      return {
+        name: "object",
+      };
+    }
+
     return {
       name: "object",
       properties: Object.keys(value).reduce((acc, key) => {

tests/basicTypes.test.ts

@@ -101,3 +101,23 @@ it("Should handle string formats inside objects inside arrays", () => {
     },
   });
 });
+
+it("should allow for shallow inference", () => {
+  expect(
+    inferType(
+      {
+        foo: [
+          {
+            ts: "2019-01-01T00:00:00.000Z",
+          },
+          {
+            ts: "2019-10-12T14:20:50.52+07:00",
+          },
+        ],
+      },
+      { shallow: true }
+    )
+  ).toEqual({
+    name: "object",
+  });
+});