@esmate/utils 1.2.4 → 1.3.1

package/README.md

@@ -23,21 +23,12 @@ npm install @esmate/utils
 
 ### ESToolkit Utilities
 
-Access [es-toolkit](https://es-toolkit.dev/reference/array/at.html) functions through the main package export or the
-dedicated toolkit subpath.
-
-**Import from main package:**
+Access [es-toolkit](https://es-toolkit.dev/reference/array/at.html) functions through the main package export.
 
 ```ts
 import { delay, invariant } from "@esmate/utils";
 ```
 
-**Import from toolkit subpath:**
-
-```ts
-import { delay, invariant } from "@esmate/utils/toolkit";
-```
-
 📚 **Documentation**: [es-toolkit reference](https://es-toolkit.dev/reference/array/at.html)
 
 ---
@@ -69,6 +60,14 @@ import { round, sqrt } from "@esmate/utils/math";
 
 ### String Utilities
 
+Access **string** utilities for common string operations.
+
+```ts
+import { fixTypos, titleize } from "@esmate/utils";
+```
+
+📚 **Documentation**: [View source](https://github.com/VienDinhCom/esmate/blob/main/packages/utils/src/string.ts)
+
 #### `titleize()`
 
 Converts strings to proper title case using the [title](https://www.npmjs.com/package/title) package.
@@ -76,10 +75,12 @@ Converts strings to proper title case using the [title](https://www.npmjs.com/pa
 ```ts
 import { titleize } from "@esmate/utils/string";
 
-const result = titleize("hello world"); // "Hello World"
-```
+const title = titleize("hello world"); // "Hello World"
 
-📚 **Documentation**: [View source](https://github.com/VienDinhCom/esmate/blob/main/packages/utils/src/string.ts)
+const chicagoTitle = titleize("love of my life", { style: "chicago" }); // "Love of My Life"
+
+const specialTitle = titleize("i love ESMate", { special: ["ESMate"] }); // "I Love ESMate"
+```
 
 #### `fixTypos()`
 
@@ -90,5 +91,3 @@ import { fixTypos } from "@esmate/utils/string";
 
 const result = fixTypos("This  is a   text with typos..."); // "This is a text with typos…"
 ```
-
-📚 **Documentation**: [View source](https://github.com/VienDinhCom/esmate/blob/main/packages/utils/src/string.ts)

package/dist/string.d.ts

@@ -3,16 +3,19 @@ import type { Configuration, Locale } from "typopo";
  * Formats a string to be used as a title.
  * @param str The string to format.
  * @param options The options to use.
+ * @param options.style The style of the title.
+ * @param options.special A list of special words to keep as-is.
  * @returns The formatted string.
  */
 export declare function titleize(str: string, options?: {
-    locale?: "en";
+    style?: "chicago";
     special?: string[];
 }): string;
 /**
  * Fixes typos in a string using typopo.
  * @param str The string to fix.
- * @param options The options to use.
+ * @param options The options to use, including `typopo` configuration.
+ * @param options.locale The locale to use (e.g., "en-us", "ru").
  * @returns The fixed string.
  */
 export declare function fixTypos(str: string, options?: Configuration & {

package/dist/string.js

@@ -3,7 +3,7 @@ import * as __WEBPACK_EXTERNAL_MODULE_title__ from "title";
 import * as __WEBPACK_EXTERNAL_MODULE_typopo__ from "typopo";
 function titleize(str, options) {
     str = str.replace(/\s+/g, " ");
-    if (options?.locale === "en") return (0, __WEBPACK_EXTERNAL_MODULE_title__["default"])(str, options);
+    if (options?.style === "chicago") return (0, __WEBPACK_EXTERNAL_MODULE_title__["default"])(str, options);
     const specialWordsLower = options?.special?.map((s)=>s.toLocaleLowerCase());
     return str.split(" ").map((word)=>specialWordsLower?.includes(word.toLocaleLowerCase()) ? word : (0, __WEBPACK_EXTERNAL_MODULE_es_toolkit_string_d01e99ad__.capitalize)(word)).join(" ");
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@esmate/utils",
   "type": "module",
-  "version": "1.2.4",
+  "version": "1.3.1",
   "description": "JavaScript/TypeScript utils, functions, and classes in one package.",
   "license": "MIT",
   "repository": {
@@ -19,8 +19,8 @@
   ],
   "exports": {
     ".": {
-      "types": "./dist/toolkit.d.ts",
-      "import": "./dist/toolkit.js"
+      "types": "./dist/pkgs/es-toolkit.d.ts",
+      "import": "./dist/pkgs/es-toolkit.js"
     },
     "./*": {
       "types": "./dist/*.d.ts",

package/dist/toolkit.d.ts

@@ -1 +0,0 @@
-export * from "es-toolkit";

package/dist/toolkit.js

@@ -1 +0,0 @@
-export * from "es-toolkit";