@esmate/utils 1.2.2 → 1.2.3

package/README.md

@@ -1 +1,94 @@
 # @esmate/utils
+
+A comprehensive utility library that consolidates powerful tools for modern JavaScript/TypeScript development. This
+package provides convenient access to es-toolkit, lodash-compatible functions, math operations, and string manipulation
+utilities through a unified interface.
+
+## Installation
+
+```bash
+npm install @esmate/utils
+```
+
+## Features
+
+- **es-toolkit**: Modern, high-performance utility functions
+- **Lodash compatibility**: Familiar lodash functions reimplemented with es-toolkit
+- **Math operations**: Comprehensive mathematical utilities via math.js
+- **String utilities**: Advanced string manipulation including title case conversion and typo correction
+
+---
+
+## Usage
+
+### 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:**
+
+```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)
+
+---
+
+### Lodash Utilities
+
+Access [lodash](https://lodash.com/docs) functions reimplemented using es-toolkit's compatibility mode for familiar,
+drop-in replacements.
+
+```ts
+import { chunk, debounce } from "@esmate/utils/lodash";
+```
+
+📚 **Documentation**: [Lodash compatibility reference](https://es-toolkit.dev/compatibility.html)
+
+---
+
+### Math Utilities
+
+Leverage the full power of [math.js](https://mathjs.org/docs/index.html) for mathematical operations and calculations.
+
+```ts
+import { round, sqrt } from "@esmate/utils/math";
+```
+
+📚 **Documentation**: [math.js reference](https://mathjs.org/docs/index.html)
+
+---
+
+### String Utilities
+
+#### `titleize()`
+
+Converts strings to proper title case using the [title](https://www.npmjs.com/package/title) package.
+
+```ts
+import { titleize } from "@esmate/utils/string";
+
+const result = titleize("hello world"); // "Hello World"
+```
+
+📚 **Documentation**: [View source](https://github.com/VienDinhCom/esmate/blob/main/packages/utils/src/string.ts)
+
+#### `fixTypos()`
+
+Automatically corrects common typographical errors using [typopo](https://www.npmjs.com/package/typopo).
+
+```ts
+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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@esmate/utils",
   "type": "module",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "JavaScript/TypeScript utils, functions, and classes in one package.",
   "license": "MIT",
   "repository": {