idchunk 1.0.1 → 1.1.1

package/README.md

@@ -1,25 +1,100 @@
-# ⚡ idchunk — A Tiny, Fast & Customizable ID Generator
+# ⚡ idchunk — Tiny, Fast & Customizable ID Generator
+
+<table width="100%" border="0">
+  <tr>
+    <td>
+      <a href="https://www.npmjs.com/package/idchunk">
+        <img src="https://img.shields.io/npm/v/idchunk.svg" alt="npm version"/>
+      </a>
+      <a href="https://www.npmjs.com/package/idchunk">
+        <img src="https://img.shields.io/npm/dt/idchunk.svg" alt="downloads"/>
+      </a>
+      <a href="https://github.com/garvthakral/idchunk/blob/main/LICENSE">
+        <img src="https://img.shields.io/npm/l/idchunk.svg" alt="license"/>
+      </a>
+    </td>
+    <td>
+      <a href="https://idchunk.netlify.app/" onclick="window.open('https://idchunk.netlify.app/', '_blank'); return false;">
+        <img  src="https://i.pinimg.com/736x/d0/68/64/d06864b8b20b18921e465d401fa605e4.jpg" alt="idchunk barcode" width="50" />
+      </a>
+    </td>
+  </tr>
+</table>
 
-[![npm version](https://img.shields.io/npm/v/idchunk.svg)](https://www.npmjs.com/package/idchunk)
-[![downloads](https://img.shields.io/npm/dt/idchunk.svg)](https://www.npmjs.com/package/idchunk)
-[![license](https://img.shields.io/npm/l/idchunk.svg)](https://github.com/garvthakral/idchunk/blob/main/LICENSE)
 
 > Generate short, unique, and customizable IDs for your applications in milliseconds.
 
 ---
 
-## Installation & Usage
+## Features
+
+- **Tiny:** Minimal footprint, zero dependencies.
+- **Fast:** Uses Node.js `crypto` for secure random generation.
+- **Customizable:** Specify ID length as needed.
+- **Reliable:** Generates collision-resistant IDs.
+
+---
+
+## Installation
 
 ```bash
 npm install idchunk
 ```
 
-By default the random generate id length is 10 
+---
+
+## Usage
+
+By default, `idchunk()` generates a random ID of length **10**:
+
+```js
+const idchunk = require("idchunk");
 
+console.log(idchunk()); // Example output: "aZ8_-kL2pQ"
 ```
+
+You can specify a custom length:
+
+```js
 const idchunk = require("idchunk");
 
-console.log(idchunk());
+console.log(idchunk(16)); // Example output: "bQ9pL2_-aZ8kL2pQ"
 ```
 
-And you can pass the value as the arguement to the idchunk(length) in number to generate the id 
+---
+
+## API
+
+### `idchunk(length?: number): string`
+
+- `length` (optional): Number. Length of the generated ID. Default is `10`.
+- Returns: A random string ID.
+
+---
+
+## How It Works
+
+- Uses Node.js [`crypto`](https://nodejs.org/api/crypto.html) for secure random number generation.
+- Character set: `a-z`, `A-Z`, `0-9`, `_`, `-`.
+
+---
+
+## Testing
+
+To test locally:
+
+```bash
+node test/index.test.js
+```
+
+---
+
+## 📄 License
+
+MIT © [Garv Thakral](https://github.com/codebygarv)
+
+---
+
+## Documentation
+
+Read full documentation here : [**Read Docs**](https://idchunk.netlify.app/)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "idchunk",
-  "version": "1.0.1",
+  "version": "1.1.1",
   "description": "A tiny, fast and customizable ID generator ",
   "main": "src/index.js",
   "keywords": [

package/src/index.js

@@ -1,14 +1,16 @@
 const values = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_-';
+const crypto = require('crypto');
 
-const idchunk = (length) =>{
+const idchunk = (length) => {
     length = length || 10;
     let result = '';
     const valuesLength = values.length;
-    
+
     for (let i = 0; i < length; i++) {
-        result += values.charAt(Math.floor(Math.random() * valuesLength));
+        const randomIndex = crypto.randomInt(0, valuesLength);
+        result += values[randomIndex];
     }
-    
+
     return result;
 }
 

package/test/index.test.js

@@ -1,3 +1,3 @@
 const idchunk = require('../src/index.js');
 
-console.log("Generated ID:", idchunk(6));
+console.log("Generated ID:", idchunk());