{"id":18961943,"url":"https://github.com/lamualfa/carret","last_synced_at":"2025-04-19T11:52:25.305Z","repository":{"id":57194545,"uuid":"324695899","full_name":"lamualfa/carret","owner":"lamualfa","description":"🌸 The collections of lightweight utilities to make your life easier.","archived":false,"fork":false,"pushed_at":"2021-08-09T18:02:14.000Z","size":219,"stargazers_count":16,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-29T07:33:30.668Z","etag":null,"topics":["charset","generator","javascript","random","shuffle","utilities"],"latest_commit_sha":null,"homepage":"https://github.com/lamualfa/carret","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"wtfpl","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lamualfa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-27T05:47:00.000Z","updated_at":"2024-08-19T12:42:12.000Z","dependencies_parsed_at":"2022-09-16T01:34:43.065Z","dependency_job_id":null,"html_url":"https://github.com/lamualfa/carret","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lamualfa%2Fcarret","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lamualfa%2Fcarret/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lamualfa%2Fcarret/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lamualfa%2Fcarret/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lamualfa","download_url":"https://codeload.github.com/lamualfa/carret/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248566641,"owners_count":21125696,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["charset","generator","javascript","random","shuffle","utilities"],"created_at":"2024-11-08T14:14:48.338Z","updated_at":"2025-04-16T04:33:03.934Z","avatar_url":"https://github.com/lamualfa.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![NPM Version](https://badgen.net/npm/v/carret?icon=npm)](https://www.npmjs.com/package/carret)\n[![Github License](https://badgen.net/github/license/lamualfa/carret?color=purple\u0026label=license)](https://github.com/lamualfa/carret/blob/master/LICENSE)\n![CI](https://github.com/lamualfa/carret/workflows/CI/badge.svg)\n[![Maintainability](https://api.codeclimate.com/v1/badges/3fc685eeb43acfed16aa/maintainability)](https://codeclimate.com/github/lamualfa/carret/maintainability)\n[![Coverage](https://codecov.io/gh/lamualfa/carret/branch/master/graph/badge.svg?token=NZ6VHIHJJV)](https://codecov.io/gh/lamualfa/carret)\n\n# Carret\n\nThe collections of lightweight utilities to make your life easier 🌸.\n\n**Advantages**\n\n- ☑️ 100% Test Coverage\n- 📦 Zero Dependencies\n- 🔀 Cross Browser Support\n- ⚡ Blazingly Fast\n- Typescript support by default\n- Support CommonJS, UMD, ESM and Modern JS format.\n- Use native `for` loop instead `forEach` or `map` method\n\n## Quick Start\n\n- [Installation](#installation)\n- [Usage](#usage)\n  - [ESM](#esm)\n  - [CommonJS](#commonjs)\n  - [CDN](#cdn)\n- [Utilities](#utilities)\n  - [Equivalent](#equivalent)\n  - [Omit by Index](#omit-by-index) - Remove specific element based on the index.\n  - [Generate Charset](#generate-charset) - Generate a Charset with custom pattern.\n  - [Random Number](#random-number) - Generate Random Number with Min \u0026 Max.\n  - [Shuffle](#shuffle) - Shuffle String or Array.\n  - [Pick Random](#pick-random) - Pick random elements from String or Array.\n\n## Installation\n\n**NPM**\n\n```bash\nnpm install carret\n```\n\n**Yarn**\n\n```bash\nyarn add carret\n```\n\n## Usage\n\n### ESM\n\n```js\nimport { equivalent, omitByIndex } from 'carret'\n```\n\n\u003e Don't worry about unnecessary `import`. It's will removed automatically with Tree Shaking.\n\n**Warning**\n\nYou might get an error if you using the import method above in project like Next.js. To solve the error, just import like this instead:\n\n```js\nimport * as carret from 'carret'\n\nconst { equivalent, omitByIndex } = carret\n```\n\n### CommonJS\n\n```js\nconst { equivalent, omitByIndex } = require('carret)\n```\n\n### CDN\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/carret@latest\"\u003e\u003c/script\u003e\n\n\u003cscript\u003e\n  const { equivalent, omitByIndex } = carret\n\u003c/script\u003e\n```\n\n## Utilities\n\n### Equivalent\n\nFunction used to get the equivalent of a `index` in the form of the entered `charset`.\n\n#### Formats\n\n**`equivalent(index, charset) : string`**\n\n- `index` - Desired index value\n- `charset` - Target charset\n\n#### Example\n\n```js\nequivalent(1502, '0123456789')\n// Output: 1502\n\nequivalent(2, 'abcdef')\n// Output: c\n\nequivalent(25, 'abcdefghijklmnopqrstuvwxyz')\n// Output: z\n\nequivalent(26, 'abcdefghijklmnopqrstuvwxyz')\n// Output: ba\n\n// With .padStart\nequivalent(6, '0123456789').padStart(4, '0')\n// Output: 0006\n```\n\n#### Use Case\n\n- Generate Alphabet Increment ID like `aaaa`, `aaab`, `aaac`, etc.\n\n\u003chr\u003e\n\n### Omit by Index\n\nFunction used to remove specific element from a string or an array.\n\n#### Formats\n\n**`omitByIndex(target: string | string[], index: number) : string | string[]`**\n\n- `target` - Target to omit\n- `charset` - The index of element to be removed\n\n#### Example\n\n```js\nomitByIndex('0123456789', 5)\n// Output: 012346789\n\nomitByIndex('abcdefg', 2)\n// Output: abdefg\n\nomitByIndex(['a', 'b', 'c', 'd'], 3)\n// Output: ['a', 'b', 'c']\n```\n\n\u003chr\u003e\n\n### Generate Charset\n\nGenerate charset using given pattern.\n\n#### Formats\n\n**`generateCharset(pattern, ?custom) : string`**\n\n- `pattern` - Pattern used to fill the charset\n\n#### Example\n\n```js\n// Alphabet (lower) \u0026 Alphabet (upper)\ngenerateCharset('aA')\n// Output: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ\n\n// Numeric \u0026 Alphabet (lower)\ngenerateCharset('0a')\n// Output: 0123456789abcdefghijklmnopqrstuvwxyz\n\n// Hex (lower)\ngenerateCharset('h')\n// Output: 0123456789abcdef\n\n// Hex (lower) + Custom\ngenerateCharset('ch', 'blabla')\n// Output: blabla0123456789abcdef\n```\n\n#### Available symbol pattern\n\n- `a` - Alphabet Lower Case (`abcdefghijklmnopqrstuvwxyz`)\n- `A` - Alphabet Upper Case (`ABCDEFGHIJKLMNOPQRSTUVWXYZ`)\n- `0` - Numeric (`0123456789`)\n- `h` - Hex Lower Case (`0123456789abcdef`)\n- `H` - Hex Upper Case (`0123456789ABCDEF`)\n- `u` - URL Friendly Characters (`0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-._~`)\n- `s` - URL Frinedly Symbol Only (`-._~`)\n- `c` - Custom characters that you pass in `custom` parameter\n\n\u003chr\u003e\n\n### Random Number\n\nGenerate random number between min(inclusive) and max(inclusive).\n\n#### Formats\n\n**`randomNumber(min, max) : number`**\n\n- `min` - Minimal random value will be generated (inclusive)\n- `max` - Max random value will be generated (inclusive)\n\n#### Example\n\n```js\nrandomNumber(0, 5)\n// Output: 4\n\nrandomNumber(0, 5)\n// Output: 0\n\nrandomNumber(0, 5)\n// Output: 3\n\nrandomNumber(0, 8)\n// Output: 8\n```\n\n\u003chr\u003e\n\n### Shuffle\n\nShuffle the entered target.\n\n#### Formats\n\n**`shuffle(target: string | string[]) : string | string[]`**\n\n- `target` - Target String or Array to be shuffled.\n\n#### Example\n\n```js\nshuffle('abc')\n// Output: bca\n\nshuffle('abcd')\n// Output: dacb\n\nshuffle('0123456')\n// Output: 2146530\n\nshuffle(['a', 'b', 'c'])\n// Output: ['c', 'a', 'b']\n```\n\n#### Use Case\n\n- Shuffling the existing charset.\n- Shuffling the dataset.\n\n\u003chr\u003e\n\n### Pick Random\n\nPick random elements from String or Array uniquely.\n\n#### Formats\n\n**`pickRandom(target: string | string[], total?: number) : string | string[]`**\n\n- `target` - Target String or Array\n- `total` - Total elements to be picked from `target`\n\n#### Example\n\n```js\npickRandom('abc', 2)\n// Output: ca\n\npickRandom('abcd', 1)\n// Output: b\n\npickRandom('0123456', 5)\n// Output: 21465\n\npickRandom(['a', 'b', 'c'], 2)\n// Output: ['c', 'b']\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flamualfa%2Fcarret","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flamualfa%2Fcarret","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flamualfa%2Fcarret/lists"}