Merge pull request #46 from behzadam/42-add-url-utility-functions

42 add url utility functions

src/url/get-params-from-url.ts

@@ -0,0 +1,29 @@
+/**
+ * Returns key/value pairs of the given url with params.
+ * Also, check out this {@link https://github.com/steven-tey/dub/blob/main/lib/utils.ts#L330C20 | link}.
+ *
+ * @param url - the given url
+ * @returns key/value pairs of param and value, or an empty object
+ * @example
+ * ```ts
+ * const params = getParamsFromURL('https://example.org/?a=1&b=2&c=3')
+ * // { a: '1', b: '2', c: '3' }
+ * ```
+ *
+ * @public
+ */
+export function getParamsFromURL(url: string): Record<string, string> {
+  if (!url) return {};
+  try {
+    const params = new URL(url).searchParams;
+    const paramsObj: Record<string, string> = {};
+    for (const [key, value] of params.entries()) {
+      if (value && value !== '') {
+        paramsObj[key] = value;
+      }
+    }
+    return paramsObj;
+  } catch (e) {
+    return {};
+  }
+}

src/url/get-url-params.test.ts

@@ -0,0 +1,12 @@
+import { getParamsFromURL } from './get-params-from-url';
+
+describe('getParamsFromURL', () => {
+  test.each`
+    input                                        | expected
+    ${'https://example.org/?a=1&b=2&c=3'}        | ${{ a: '1', b: '2', c: '3' }}
+    ${'https://example.org/?t=Salz+%26+Pfeffer'} | ${{ t: 'Salz & Pfeffer' }}
+    ${'https://example.org/'}                    | ${{}}
+  `('returns $expected when input is: $input', ({ input, expected }) => {
+    expect(getParamsFromURL(input)).toStrictEqual(expected);
+  });
+});