feat: added jsonParse()

Author: webdeveric

src/index.ts

@@ -36,6 +36,7 @@ export * from './inRange.js';
 export * from './isEmpty.js';
 export * from './iterateForever.js';
 export * from './joinStrings.js';
+export * from './jsonParse.js';
 export * from './looksLikeURL.js';
 export * from './normalize.js';
 export * from './parseNumber.js';

src/jsonParse.ts

@@ -0,0 +1,17 @@
+import type { TypeAssertionFn } from './types/functions.js';
+
+export type JsonReviver = Parameters<JSON['parse']>[1];
+
+export function jsonParse(input: string): unknown;
+
+export function jsonParse(input: string, reviver?: JsonReviver): unknown;
+
+export function jsonParse<T>(input: string, reviver: JsonReviver | undefined, assertionFn: TypeAssertionFn<T>): T;
+
+export function jsonParse<T>(input: string, reviver?: JsonReviver, assertionFn?: TypeAssertionFn<T>): unknown {
+  const data: unknown = JSON.parse(input, reviver);
+
+  assertionFn?.(data);
+
+  return data;
+}

test/jsonParse.test.ts

@@ -0,0 +1,32 @@
+import { describe, expect, it } from 'vitest';
+
+import { assertIsObject } from '../src/assertion/assertIsObject.js';
+import { jsonParse } from '../src/jsonParse.js';
+
+describe('jsonParse()', () => {
+  it('Parses a JSON string', () => {
+    const unknownData = jsonParse('{"name":"test"}');
+
+    expect(unknownData).toEqual({
+      name: 'test',
+    });
+  });
+
+  it('Can use a reviver function', () => {
+    const unknownData = jsonParse('{"name":"test"}', (key, value) => {
+      return key === 'name' ? String(value).toUpperCase() : value;
+    });
+
+    expect(unknownData).toEqual({
+      name: 'TEST',
+    });
+  });
+
+  it('Can use a type assertion function', () => {
+    expect(jsonParse('{"name":"test"}', undefined, assertIsObject)).toEqual({
+      name: 'test',
+    });
+
+    expect(() => jsonParse('[]', undefined, assertIsObject)).toThrowError();
+  });
+});