feat: add isJSON util fn

.changeset/warm-news-sparkle.md

@@ -0,0 +1,5 @@
+---
+"@opentf/utils": minor
+---
+
+Added isJSON types utility fn.

README.md

@@ -84,6 +84,7 @@ await sleep(1000); // It suspends the exection for 1 second.
 
 - [isObj](https://js-utils.pages.dev/docs/Object/isObj)
 - [isNumber](https://js-utils.pages.dev/docs/Types/isNumber)
+- [isJSON](https://js-utils.pages.dev/docs/Types/isJSON)
 
 ## License
 

apps/website/docs/Types/isJSON.mdx

@@ -0,0 +1,53 @@
+> Checks whether the given string is a valid JSON plain object
+
+## Syntax
+
+```ts
+import { isJSON } from '@opentf/utils';
+
+isJSON(str: string): boolean;
+```
+
+## Examples
+
+```ts
+// Falsy cases
+// ***********
+
+isJSON(""); //=> false
+
+isJSON("undefined"); //=> false
+
+isJSON("null"); //=> false
+
+isJSON("true"); //=> false
+
+isJSON("false"); //=> false
+
+isJSON("1"); //=> false
+
+isJSON("12345"); //=> false
+
+isJSON("abc"); //=> false
+
+isJSON("{a}"); //=> false
+
+isJSON("{a:}"); //=> false
+
+isJSON("{a:1}"); //=> false
+
+isJSON('{"a": undefined}'); //=> false
+
+isJSON("[]"); //=> false
+
+// Truthy cases
+// ************
+
+isJSON("{}"); //=> true
+
+isJSON('{"a":1}'); //=> true
+
+isJSON(
+  '{"a": "abc", "b": true, "c": false, "d": [{"e": 1}, null, 5.0], "f": {}}'
+); //=> true
+```

packages/utils/README.md

@@ -84,6 +84,7 @@ await sleep(1000); // It suspends the exection for 1 second.
 
 - [isObj](https://js-utils.pages.dev/Object/isObj)
 - [isNumber](https://js-utils.pages.dev/Types/isNumber)
+- [isJSON](https://js-utils.pages.dev/docs/Types/isJSON)
 
 ## License
 

packages/utils/__tests__/types/isJSON.ts

@@ -0,0 +1,30 @@
+import { isJSON } from '../../src';
+
+describe('Types > isJSON', () => {
+  test('invalid cases', () => {
+    expect(isJSON()).toBeFalsy();
+    expect(isJSON('')).toBeFalsy();
+    expect(isJSON('undefined')).toBeFalsy();
+    expect(isJSON('null')).toBeFalsy();
+    expect(isJSON('true')).toBeFalsy();
+    expect(isJSON('false')).toBeFalsy();
+    expect(isJSON('1')).toBeFalsy();
+    expect(isJSON('12345')).toBeFalsy();
+    expect(isJSON('abc')).toBeFalsy();
+    expect(isJSON('{a}')).toBeFalsy();
+    expect(isJSON('{a:}')).toBeFalsy();
+    expect(isJSON('{a:1}')).toBeFalsy();
+    expect(isJSON('{"a": undefined}')).toBeFalsy();
+    expect(isJSON('[]')).toBeFalsy();
+  });
+
+  test('valid cases', () => {
+    expect(isJSON('{}')).toBeTruthy();
+    expect(isJSON('{"a":1}')).toBeTruthy();
+    expect(
+      isJSON(
+        '{"a": "abc", "b": true, "c": false, "d": [{"e": 1}, null, 5.0], "f": {}}'
+      )
+    ).toBeTruthy();
+  });
+});

packages/utils/__tests__/object/isObjType.spec.ts → packages/utils/__tests__/types/isObj.spec.ts

@@ -5,7 +5,7 @@ function fun(x?: any) {
   return x;
 }
 
-describe('Object', () => {
+describe('Types', () => {
   test('isObj', () => {
     expect(isObj(undefined)).toBeFalsy();
     expect(isObj(null)).toBeFalsy();

packages/utils/src/index.ts

@@ -20,6 +20,7 @@ export { default as percentageOf } from './maths/percentageOf';
 // Types
 export { default as isNumber } from './types/isNumber';
 export { default as isObj } from './types/isObj';
+export { default as isJSON } from './types/isJSON';
 
 // Object
 export { default as getInObj } from './object/getInObj';

packages/utils/src/types/isJSON.ts

@@ -0,0 +1,21 @@
+import isObj from './isObj';
+/**
+ * Checks whether the given string is a valid JSON plain object
+ *
+ * @example
+ *
+ * isJSON("null") //=> false
+ *
+ * isJSON("[]") //=> false
+ *
+ * isJSON("{}") //=> true
+ */
+
+export default function isJSON(str: string) {
+  try {
+    const o = JSON.parse(str);
+    return isObj(o);
+  } catch (error) {
+    return false;
+  }
+}