feat: added tryParseURL (#482)

Co-authored-by: Jeroen Claassens <support@favware.tech>
sapphiredev · Oct 8, 2022 · 46c5b49 · 46c5b49
1 parent 3eb5175
commit 46c5b49
Show file tree

Hide file tree

Showing 9 changed files with 56 additions and 42 deletions.
diff --git a/packages/utilities/package.json b/packages/utilities/package.json
@@ -216,10 +216,10 @@
 			"import": "./dist/lib/objectValues.mjs",
 			"require": "./dist/lib/objectValues.js"
 		},
-		"./parseUrl": {
-			"types": "./dist/lib/parseUrl.d.ts",
-			"import": "./dist/lib/parseUrl.mjs",
-			"require": "./dist/lib/parseUrl.js"
+		"./parseURL": {
+			"types": "./dist/lib/tryParseURL.d.ts",
+			"import": "./dist/lib/tryParseURL.mjs",
+			"require": "./dist/lib/tryParseURL.js"
 		},
 		"./partition": {
 			"types": "./dist/lib/partition.d.ts",
@@ -262,9 +262,19 @@
 			"require": "./dist/lib/toTitleCase.js"
 		},
 		"./tryParse": {
-			"types": "./dist/lib/tryParse.d.ts",
-			"import": "./dist/lib/tryParse.mjs",
-			"require": "./dist/lib/tryParse.js"
+			"types": "./dist/lib/tryParseJSON.d.ts",
+			"import": "./dist/lib/tryParseJSON.mjs",
+			"require": "./dist/lib/tryParseJSON.js"
+		},
+		"./tryParseJSON": {
+			"types": "./dist/lib/tryParseJSON.d.ts",
+			"import": "./dist/lib/tryParseJSON.mjs",
+			"require": "./dist/lib/tryParseJSON.js"
+		},
+		"./tryParseURL": {
+			"types": "./dist/lib/tryParseURL.d.ts",
+			"import": "./dist/lib/tryParseURL.mjs",
+			"require": "./dist/lib/tryParseURL.js"
 		},
 		"./types": {
 			"types": "./dist/lib/types.d.ts",

diff --git a/packages/utilities/src/index.ts b/packages/utilities/src/index.ts
@@ -30,13 +30,13 @@ export * from './lib/objectEntries';
 export * from './lib/objectKeys';
 export * from './lib/objectToTuples';
 export * from './lib/objectValues';
-export * from './lib/parseUrl';
 export * from './lib/partition';
 export * from './lib/range';
 export * from './lib/regExpEsc';
 export * from './lib/roundNumber';
-export { sleep, sleepSync, AbortError, type SleepOptions } from './lib/sleep';
+export { AbortError, sleep, sleepSync, type SleepOptions } from './lib/sleep';
 export * from './lib/splitText';
 export { toTitleCase, type ToTitleCaseOptions } from './lib/toTitleCase';
-export * from './lib/tryParse';
+export * from './lib/tryParseJSON';
+export * from './lib/tryParseURL';
 export * from './lib/types';
diff --git a/packages/utilities/src/lib/parseUrl.ts b/packages/utilities/src/lib/parseUrl.ts
diff --git a/packages/utilities/src/lib/tryParse.ts → packages/utilities/src/lib/tryParseJSON.ts b/packages/utilities/src/lib/tryParse.ts → packages/utilities/src/lib/tryParseJSON.ts
@@ -2,10 +2,12 @@
  * Try parse a stringified JSON string.
  * @param value The value to parse
  */
-export function tryParse(value: string): object | string {
+export function tryParseJSON(value: string): object | string | number {
 	try {
 		return JSON.parse(value);
 	} catch (err) {
 		return value;
 	}
 }
+
+export { tryParseJSON as tryParse };
diff --git a/packages/utilities/src/lib/tryParseURL.ts b/packages/utilities/src/lib/tryParseURL.ts
@@ -0,0 +1,14 @@
+/**
+ * Tries parse a string to a {@link URL} object
+ * @param value The possible URL to parse
+ * @returns an URL object if it was a valid URL or `null` if it was not.
+ */
+export function tryParseURL(value: string): URL | null {
+	try {
+		return new URL(value);
+	} catch {
+		return null;
+	}
+}
+
+export { tryParseURL as parseURL };
diff --git a/packages/utilities/tests/parseUrl.test.ts b/packages/utilities/tests/parseUrl.test.ts
diff --git a/packages/utilities/tests/tryParse.test.ts → ...ages/utilities/tests/tryParseJSON.test.ts b/packages/utilities/tests/tryParse.test.ts → ...ages/utilities/tests/tryParseJSON.test.ts
@@ -1,15 +1,15 @@
-import { tryParse } from '../src';
+import { tryParseJSON } from '../src';
 
-describe('tryParse', () => {
+describe('tryParseJSON', () => {
 	test('GIVEN basic THEN returns expected', () => {
 		const source = '{"a":4,"b":6}';
 		const expected = { a: 4, b: 6 };
-		expect(tryParse(source)).toEqual(expected);
+		expect(tryParseJSON(source)).toEqual(expected);
 	});
 
 	test('GIVEN invalid THEN returns expected', () => {
 		const source = '{"a":4,"b:6}';
 		const expected = '{"a":4,"b:6}';
-		expect(tryParse(source)).toEqual(expected);
+		expect(tryParseJSON(source)).toEqual(expected);
 	});
 });
diff --git a/packages/utilities/tests/tryParseURL.test.ts b/packages/utilities/tests/tryParseURL.test.ts
@@ -0,0 +1,12 @@
+import { URL } from 'url';
+import { tryParseURL } from '../src';
+
+describe('tryParseURL', () => {
+	test('GIVEN valid URL THEN returns URL', () => {
+		expect(tryParseURL('https://skyra.pw')).toStrictEqual(new URL('https://skyra.pw'));
+	});
+
+	test('GIVEN invalid url THEN returns null', () => {
+		expect(tryParseURL('thisisnotaurl')).toBeNull();
+	});
+});
diff --git a/scripts/aliases/utilities.mjs b/scripts/aliases/utilities.mjs
@@ -5,5 +5,7 @@ export const aliasStore = new Map([
 	['isNullOrUndefined', 'isNullish'],
 	['isNullOrUndefinedOrEmpty', 'isNullishOrEmpty'],
 	['isNullOrUndefinedOrZero', 'isNullishOrZero'],
-	['sleep', 'sleepSync']
+	['sleep', 'sleepSync'],
+	['tryParseJSON', 'tryParse'],
+	['tryParseURL', 'parseURL']
 ]);