es-toolkit 1.52.0-dev.2130 → 1.52.0-dev.2131

package/dist/query-string/index.d.mts

@@ -0,0 +1,2 @@
+import { stringify } from "./stringify.mjs";
+export { stringify };

package/dist/query-string/index.d.ts

@@ -0,0 +1,2 @@
+import { stringify } from "./stringify.js";
+export { stringify };

package/dist/query-string/index.js

@@ -0,0 +1,3 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_stringify = require("./stringify.js");
+exports.stringify = require_stringify.stringify;

package/dist/query-string/index.mjs

@@ -0,0 +1,2 @@
+import { stringify } from "./stringify.mjs";
+export { stringify };

package/dist/query-string/stringify.d.mts

@@ -0,0 +1,25 @@
+//#region src/query-string/stringify.d.ts
+type QueryValue = string | number | boolean | bigint | null | undefined;
+/**
+ * Converts a flat object into a URL search string, such as `?a=1&b=2`.
+ *
+ * - `null` and `undefined` values are omitted, including inside arrays.
+ * - Arrays are serialized as repeated keys, such as `a=1&a=2`.
+ * - Other values are converted with `String()`.
+ * - Keys and values are encoded with `encodeURIComponent`, so spaces become `%20` and `+` becomes `%2B`.
+ *
+ * @template T - The type of the object to serialize.
+ * @param query - The object to serialize.
+ * @returns The search string starting with `?`, or an empty string when there is nothing to serialize.
+ * @throws {URIError} Throws when a key or value contains an unpaired surrogate.
+ *
+ * @example
+ * stringify({ page: 1, tags: ['a', 'b'], q: 'hello world', ref: undefined });
+ * // => '?page=1&tags=a&tags=b&q=hello%20world'
+ *
+ * stringify({ ref: undefined });
+ * // => ''
+ */
+declare function stringify<T extends object & { [K in keyof T]: QueryValue | readonly QueryValue[] }>(query: T): string;
+//#endregion
+export { stringify };

package/dist/query-string/stringify.d.ts

@@ -0,0 +1,25 @@
+//#region src/query-string/stringify.d.ts
+type QueryValue = string | number | boolean | bigint | null | undefined;
+/**
+ * Converts a flat object into a URL search string, such as `?a=1&b=2`.
+ *
+ * - `null` and `undefined` values are omitted, including inside arrays.
+ * - Arrays are serialized as repeated keys, such as `a=1&a=2`.
+ * - Other values are converted with `String()`.
+ * - Keys and values are encoded with `encodeURIComponent`, so spaces become `%20` and `+` becomes `%2B`.
+ *
+ * @template T - The type of the object to serialize.
+ * @param query - The object to serialize.
+ * @returns The search string starting with `?`, or an empty string when there is nothing to serialize.
+ * @throws {URIError} Throws when a key or value contains an unpaired surrogate.
+ *
+ * @example
+ * stringify({ page: 1, tags: ['a', 'b'], q: 'hello world', ref: undefined });
+ * // => '?page=1&tags=a&tags=b&q=hello%20world'
+ *
+ * stringify({ ref: undefined });
+ * // => ''
+ */
+declare function stringify<T extends object & { [K in keyof T]: QueryValue | readonly QueryValue[] }>(query: T): string;
+//#endregion
+export { stringify };

package/dist/query-string/stringify.js

@@ -0,0 +1,37 @@
+//#region src/query-string/stringify.ts
+/**
+* Converts a flat object into a URL search string, such as `?a=1&b=2`.
+*
+* - `null` and `undefined` values are omitted, including inside arrays.
+* - Arrays are serialized as repeated keys, such as `a=1&a=2`.
+* - Other values are converted with `String()`.
+* - Keys and values are encoded with `encodeURIComponent`, so spaces become `%20` and `+` becomes `%2B`.
+*
+* @template T - The type of the object to serialize.
+* @param query - The object to serialize.
+* @returns The search string starting with `?`, or an empty string when there is nothing to serialize.
+* @throws {URIError} Throws when a key or value contains an unpaired surrogate.
+*
+* @example
+* stringify({ page: 1, tags: ['a', 'b'], q: 'hello world', ref: undefined });
+* // => '?page=1&tags=a&tags=b&q=hello%20world'
+*
+* stringify({ ref: undefined });
+* // => ''
+*/
+function stringify(query) {
+	const parts = [];
+	const keys = Object.keys(query);
+	for (let i = 0; i < keys.length; i++) {
+		const key = keys[i];
+		const value = query[key];
+		const values = Array.isArray(value) ? value : [value];
+		for (let j = 0; j < values.length; j++) {
+			const item = values[j];
+			if (item != null) parts.push(`${encodeURIComponent(key)}=${encodeURIComponent(String(item))}`);
+		}
+	}
+	return parts.length === 0 ? "" : `?${parts.join("&")}`;
+}
+//#endregion
+exports.stringify = stringify;

package/dist/query-string/stringify.mjs

@@ -0,0 +1,37 @@
+//#region src/query-string/stringify.ts
+/**
+* Converts a flat object into a URL search string, such as `?a=1&b=2`.
+*
+* - `null` and `undefined` values are omitted, including inside arrays.
+* - Arrays are serialized as repeated keys, such as `a=1&a=2`.
+* - Other values are converted with `String()`.
+* - Keys and values are encoded with `encodeURIComponent`, so spaces become `%20` and `+` becomes `%2B`.
+*
+* @template T - The type of the object to serialize.
+* @param query - The object to serialize.
+* @returns The search string starting with `?`, or an empty string when there is nothing to serialize.
+* @throws {URIError} Throws when a key or value contains an unpaired surrogate.
+*
+* @example
+* stringify({ page: 1, tags: ['a', 'b'], q: 'hello world', ref: undefined });
+* // => '?page=1&tags=a&tags=b&q=hello%20world'
+*
+* stringify({ ref: undefined });
+* // => ''
+*/
+function stringify(query) {
+	const parts = [];
+	const keys = Object.keys(query);
+	for (let i = 0; i < keys.length; i++) {
+		const key = keys[i];
+		const value = query[key];
+		const values = Array.isArray(value) ? value : [value];
+		for (let j = 0; j < values.length; j++) {
+			const item = values[j];
+			if (item != null) parts.push(`${encodeURIComponent(key)}=${encodeURIComponent(String(item))}`);
+		}
+	}
+	return parts.length === 0 ? "" : `?${parts.join("&")}`;
+}
+//#endregion
+export { stringify };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "es-toolkit",
-  "version": "1.52.0-dev.2130+5f7c64c3",
+  "version": "1.52.0-dev.2131+5f0e6b21",
   "description": "A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.",
   "homepage": "https://es-toolkit.dev",
   "bugs": "https://github.com/toss/es-toolkit/issues",
@@ -174,6 +174,16 @@
         "default": "./dist/promise/index.js"
       }
     },
+    "./query-string": {
+      "import": {
+        "types": "./dist/query-string/index.d.mts",
+        "default": "./dist/query-string/index.mjs"
+      },
+      "require": {
+        "types": "./dist/query-string/index.d.ts",
+        "default": "./dist/query-string/index.js"
+      }
+    },
     "./set": {
       "import": {
         "types": "./dist/set/index.d.mts",
@@ -257,6 +267,7 @@
     "object.js",
     "predicate.js",
     "promise.js",
+    "query-string.js",
     "set.js",
     "string.js",
     "server.js",
@@ -485,6 +496,16 @@
           "default": "./dist/promise/index.js"
         }
       },
+      "./query-string": {
+        "import": {
+          "types": "./dist/query-string/index.d.mts",
+          "default": "./dist/query-string/index.mjs"
+        },
+        "require": {
+          "types": "./dist/query-string/index.d.ts",
+          "default": "./dist/query-string/index.js"
+        }
+      },
       "./set": {
         "import": {
           "types": "./dist/set/index.d.mts",

package/query-string.d.ts

@@ -0,0 +1 @@
+export * from './dist/query-string';

package/query-string.js

@@ -0,0 +1 @@
+module.exports = require('./dist/query-string');