Merge pull request #21445 from demurgos/add-object-inspect

Add types for `object-inspect@1.4`

types/object-inspect/index.d.ts

@@ -0,0 +1,27 @@
+// Type definitions for object-inspect 1.4
+// Project: https://github.com/substack/object-inspect
+// Definitions by: Charles Samborski <https://github.com/demurgos>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+declare namespace objectInspect {
+    /**
+     * Inspection options
+     */
+    interface Options {
+        /**
+         * Maximum depth of the inspection. Default: `5`.
+         */
+        depth?: number;
+    }
+}
+
+/**
+ * Return a string `s` with the string representation of `obj` up to a depth of `opts.depth`.
+ *
+ * @param obj Object to inspect
+ * @param opts Inspection options. Default: `{}`.
+ * @return String representation of `obj`
+ */
+declare function objectInspect(obj: any, opts?: objectInspect.Options): string;
+
+export = objectInspect;

types/object-inspect/object-inspect-tests.ts

@@ -0,0 +1,10 @@
+import objectInspect = require('object-inspect');
+
+// $ExpectType string
+objectInspect({foo: "bar"});
+
+// $ExpectType string
+objectInspect({foo: "bar"}, {});
+
+// $ExpectType string
+objectInspect({foo: "bar"}, {depth: Infinity});

types/object-inspect/tsconfig.json

@@ -0,0 +1,23 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "object-inspect-tests.ts"
+    ]
+}

types/object-inspect/tslint.json

@@ -0,0 +1 @@
+{ "extends": "dtslint/dt.json" }