js-utils-kit 0.1.0 → 0.2.0

package/README.md

@@ -1,3 +1,153 @@
-# JS Utils Kit
+<div align="center">
 
-A compact library of essential JavaScript utility functions—such as array operations, object helpers, Promise utilities, and type checks. Designed to be lightweight, dependable, and effortlessly integrated into JS or TS projects, it has minimal bundle impact and works seamlessly with modern bundlers.
+[![img](https://capsule-render.vercel.app/api?type=waving&height=300&color=gradient&text=Js%20Utils%20Kit&section=footer&desc=Modular%20JavaScript%20utilities%20with%20type%20support%20for%20strings,%20objects,%20arrays,%20and%20more&descAlign=49&descAlignY=72&animation=fadeIn&textBg=false)](https://github.com/TenEplaysOfficial/js-utils-kit)
+
+[![npm version](https://img.shields.io/npm/v/js-utils-kit.svg?style=for-the-badge)](https://www.npmjs.com/package/js-utils-kit)
+[![License](https://img.shields.io/github/license/TenEplaysOfficial/js-utils-kit.svg?style=for-the-badge)](https://github.com/TenEplaysOfficial/js-utils-kit/blob/main/LICENSE)
+[![Bundle size](https://img.shields.io/bundlephobia/minzip/js-utils-kit?style=for-the-badge)](https://bundlephobia.com/package/js-utils-kit)
+[![Build](https://img.shields.io/github/actions/workflow/status/TenEplaysOfficial/js-utils-kit/weekly-release.yml?label=Build&style=for-the-badge)](https://github.com/TenEplaysOfficial/js-utils-kit)
+[![GitHub stars](https://img.shields.io/github/stars/TenEplaysOfficial/js-utils-kit?style=for-the-badge)](https://github.com/TenEplaysOfficial/js-utils-kit/stargazers)
+[![Issues](https://img.shields.io/github/issues/TenEplaysOfficial/js-utils-kit?style=for-the-badge)](https://github.com/TenEplaysOfficial/js-utils-kit/issues)
+[![PRs](https://img.shields.io/github/issues-pr/TenEplaysOfficial/js-utils-kit?style=for-the-badge)](https://github.com/TenEplaysOfficial/js-utils-kit/pulls)
+[![Last Commit](https://img.shields.io/github/last-commit/TenEplaysOfficial/js-utils-kit?style=for-the-badge)](https://github.com/TenEplaysOfficial/js-utils-kit/commits)
+[![Discussions](https://img.shields.io/github/discussions/TenEplaysOfficial/js-utils-kit?style=for-the-badge)](https://github.com/TenEplaysOfficial/js-utils-kit/discussions)
+[![Downloads](https://img.shields.io/npm/dm/js-utils-kit?style=for-the-badge)](https://www.npmjs.com/package/js-utils-kit)
+[![GitHub repo size](https://img.shields.io/github/repo-size/TenEplaysOfficial/js-utils-kit?style=for-the-badge)](https://github.com/TenEplaysOfficial/js-utils-kit)
+[![Type Support](https://img.shields.io/badge/type-support-blue?style=for-the-badge)](https://github.com/TenEplaysOfficial/js-utils-kit)
+[![Sponsor](https://img.shields.io/badge/funding-sponsor-yellow?style=for-the-badge)](https://github.com/sponsors/TenEplaysOfficial)
+[![Follow @teneplays on X](https://img.shields.io/badge/follow-@teneplays-fff?logo=x&style=for-the-badge)](https://x.com/teneplays)
+
+</div>
+
+**JS Utils Kit** is a compact and reliable library of essential JavaScript utility functions. It includes helpers for arrays, objects, numbers, promises, type checking, and more. Designed for performance and modularity, it integrates easily into JavaScript and TypeScript projects with minimal impact on bundle size.
+
+> Streamline your code with battle-tested, tree-shakable utilities.
+
+This package includes utilities designed for both browser and Node.js environments, clearly organized and optimized for cross-platform compatibility.
+
+## Installation
+
+```sh
+yarn add js-utils-kit
+# or
+npm install js-utils-kit
+```
+
+## Usage
+
+`js-utils-kit` offers a modular structure for utilities across different categories like `number`, `string`, `array`, `object`, `env`, and more. You can use full or scoped imports depending on your preference and project setup.
+
+### Recommended Import
+
+Import only what you need by utility category:
+
+```ts
+import number from 'js-utils-kit/number';
+import string from 'js-utils-kit/string';
+import array from 'js-utils-kit/array';
+import object from 'js-utils-kit/object';
+import env from 'js-utils-kit/env';
+
+console.log(number.clamp(150, 0, 100)); // 100
+console.log(string.capitalize('hello world')); // 'Hello World'
+console.log(array.unique([1, 2, 2, 3])); // [1, 2, 3]
+console.log(object.isEmpty({})); // true
+console.log(env.isBrowser()); // true/false
+```
+
+### Full Import (All utils in one namespace)
+
+```ts
+import * as kit from 'js-utils-kit';
+
+console.log(kit.number.clamp(150, 0, 100)); // 100
+console.log(kit.string.capitalize('hello')); // 'Hello'
+console.log(kit.array.unique([1, 1, 2])); // [1, 2]
+console.log(kit.object.isEmpty({})); // true
+console.log(kit.env.isNode()); // true/false
+```
+
+### Named Imports
+
+```ts
+import { number, string, env } from 'js-utils-kit';
+
+console.log(number.clamp(42, 0, 100)); // 42
+console.log(string.capitalize('js-utils-kit')); // 'Js-utils-kit'
+console.log(env.isDev()); // true/false
+```
+
+### CommonJS Usage
+
+```js
+const { number, string, array, object, env } = require('js-utils-kit');
+
+console.log(number.clamp(150, 0, 100)); // 100
+console.log(string.capitalize('hello world')); // 'Hello World'
+console.log(array.unique([1, 2, 2, 3])); // [1, 2, 3]
+console.log(object.isEmpty({})); // true
+console.log(env.isBrowser()); // true/false
+```
+
+## Features
+
+- Organized by category (e.g., `number`, `string`, `file`, etc.)
+- Fully typed with TypeScript
+- Thoroughly tested with Jest
+- Tree-shakable and supports both ESM and CJS
+- CLI-ready tools for file and system operations
+
+## Documentation
+
+Full documentation available at [GitHub Pages](https://teneplaysofficial.github.io/js-utils-kit/)
+
+## Requirements
+
+- Node.js: Version `18.0.0` or higher
+- Yarn (or npm as an alternative)
+- TypeScript (optional, for TypeScript projects or development)
+- Browsers: Modern browsers for browser-based usage
+
+## Contributing
+
+We welcome contributions whether it's fixing bugs, adding utilities, improving docs, or writing tests. See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines and join our [GitHub Discussions](https://github.com/TenEplaysOfficial/js-utils-kit/discussions) to share ideas or propose features.
+
+## FAQ
+
+<details>
+<summary>Does it work in browsers?</summary>
+
+Yes, **JS Utils Kit** is compatible with modern browsers and Node.js.
+
+</details>
+
+<details>
+<summary>Do I need TypeScript?</summary>
+
+No, the library works in plain JavaScript, but TypeScript users benefit from full type definitions and editor support.
+
+</details>
+
+<details>
+<summary>How do I report a bug?</summary>
+
+Open an issue on [GitHub](https://github.com/TenEplaysOfficial/js-utils-kit/issues) or join the [Discussions](https://github.com/TenEplaysOfficial/js-utils-kit/discussions) to ask questions or share feedback.
+
+</details>
+
+<details>
+<summary>How can I optimize bundle size?</summary>
+
+Import only what you need:
+
+```ts
+import { clamp } from 'js-utils-kit/number';
+```
+
+This enables tree-shaking for smaller, optimized bundles.
+
+</details>
+
+## License
+
+Released under the [MIT License](LICENSE)

package/dist/char/index.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const r=()=>Array.from({length:26},(r,e)=>String.fromCharCode(97+e)),e=()=>Array.from({length:26},(r,e)=>String.fromCharCode(65+e)),o=()=>Array.from({length:10},(r,e)=>String.fromCharCode(48+e)),t=()=>[...r(),...e(),...o()];var s={lowercase:r,uppercase:e,digits:o,all:t};exports.all=t,exports.default=s,exports.digits=o,exports.lowercase=r,exports.uppercase=e;

package/dist/char/index.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Generates an array of lowercase ASCII alphabet characters (a–z).
+ *
+ * @returns {string[]} An array containing 'a' to 'z'.
+ * @example
+ * lowercase(); // ['a', 'b', ..., 'z']
+ */
+declare const lowercase: () => string[];
+/**
+ * Generates an array of uppercase ASCII alphabet characters (A–Z).
+ *
+ * @returns {string[]} An array containing 'A' to 'Z'.
+ * @example
+ * uppercase(); // ['A', 'B', ..., 'Z']
+ */
+declare const uppercase: () => string[];
+/**
+ * Generates an array of ASCII digit characters (0–9).
+ *
+ * @returns {string[]} An array containing '0' to '9'.
+ * @example
+ * digits(); // ['0', '1', ..., '9']
+ */
+declare const digits: () => string[];
+/**
+ * Combines lowercase, uppercase, and digit characters into a single array.
+ *
+ * @returns {string[]} An array containing 'a'–'z', 'A'–'Z', and '0'–'9'.
+ * @example
+ * all(); // ['a', ..., 'z', 'A', ..., 'Z', '0', ..., '9']
+ */
+declare const all: () => string[];
+
+declare const _default: {
+    lowercase: () => string[];
+    uppercase: () => string[];
+    digits: () => string[];
+    all: () => string[];
+};
+
+export { all, _default as default, digits, lowercase, uppercase };

package/dist/char/index.js

@@ -0,0 +1 @@
+const r=()=>Array.from({length:26},(r,a)=>String.fromCharCode(97+a)),a=()=>Array.from({length:26},(r,a)=>String.fromCharCode(65+a)),e=()=>Array.from({length:10},(r,a)=>String.fromCharCode(48+a)),o=()=>[...r(),...a(),...e()];var t={lowercase:r,uppercase:a,digits:e,all:o};export{o as all,t as default,e as digits,r as lowercase,a as uppercase};