{"id":13594973,"url":"https://github.com/sqids/sqids-javascript","last_synced_at":"2025-12-29T22:32:08.639Z","repository":{"id":176746977,"uuid":"658041382","full_name":"sqids/sqids-javascript","owner":"sqids","description":"Official JavaScript port of Sqids. Generate short unique IDs from numbers.","archived":false,"fork":false,"pushed_at":"2025-03-25T01:35:59.000Z","size":1369,"stargazers_count":747,"open_issues_count":2,"forks_count":17,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-03T11:42:47.630Z","etag":null,"topics":["hashids","id","id-generator","javascript","short","short-id","short-url","sqids","typescript","uid","unique-id","unique-id-generator"],"latest_commit_sha":null,"homepage":"https://sqids.org/javascript","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sqids.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-24T15:27:15.000Z","updated_at":"2025-03-29T10:01:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"74f55e6c-bd19-401d-bb7e-c5ba2ad95a4c","html_url":"https://github.com/sqids/sqids-javascript","commit_stats":null,"previous_names":["sqids/sqids-javascript"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqids%2Fsqids-javascript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqids%2Fsqids-javascript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqids%2Fsqids-javascript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqids%2Fsqids-javascript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sqids","download_url":"https://codeload.github.com/sqids/sqids-javascript/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248020593,"owners_count":21034459,"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":["hashids","id","id-generator","javascript","short","short-id","short-url","sqids","typescript","uid","unique-id","unique-id-generator"],"created_at":"2024-08-01T16:01:41.704Z","updated_at":"2025-12-29T22:32:08.633Z","avatar_url":"https://github.com/sqids.png","language":"TypeScript","readme":"# [Sqids JavaScript](https://sqids.org/javascript)\n\n[![npm version](https://img.shields.io/npm/v/sqids.svg)](https://www.npmjs.com/package/sqids)\n[![Downloads](https://img.shields.io/npm/dm/sqids)](https://www.npmjs.com/package/sqids)\n\n[Sqids](https://sqids.org/javascript) (*pronounced \"squids\"*) is a small library that lets you **generate unique IDs from numbers**. It's good for link shortening, fast \u0026 URL-safe ID generation and decoding back into numbers for quicker database lookups.\n\nFeatures:\n\n- **Encode multiple numbers** - generate short IDs from one or several non-negative numbers\n- **Quick decoding** - easily decode IDs back into numbers\n- **Unique IDs** - generate unique IDs by shuffling the alphabet once\n- **ID padding** - provide minimum length to make IDs more uniform\n- **URL safe** - auto-generated IDs do not contain common profanity\n- **Randomized output** - Sequential input provides nonconsecutive IDs\n- **Many implementations** - Support for [40+ programming languages](https://sqids.org/)\n\n## 🧰 Use-cases\n\nGood for:\n\n- Generating IDs for public URLs (eg: link shortening)\n- Generating IDs for internal systems (eg: event tracking)\n- Decoding for quicker database lookups (eg: by primary keys)\n\nNot good for:\n\n- Sensitive data (this is not an encryption library)\n- User IDs (can be decoded revealing user count)\n\n## 🚀 Getting started\n\nyarn:\n\n```bash\nyarn add sqids\n```\n\n[npm](https://www.npmjs.com/package/sqids):\n\n```bash\nnpm install sqids\n```\n\n[cdnjs](https://cdnjs.com/libraries/sqids):\n\n```html\n\u003cscript src=\"https://cdnjs.cloudflare.com/ajax/libs/sqids/0.3.0/sqids.min.js\"\u003e\u003c/script\u003e\n```\n\n[jsDelivr](https://www.jsdelivr.com/package/npm/sqids):\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/sqids/dist/sqids.min.js\"\u003e\u003c/script\u003e\n```\n\n## 👩‍💻 Examples\n\nSimple encode \u0026 decode:\n\n```javascript\nimport Sqids from 'sqids'\n\nconst sqids = new Sqids()\nconst id = sqids.encode([1, 2, 3]) // \"86Rf07\"\nconst numbers = sqids.decode(id) // [1, 2, 3]\n```\n\n\u003e **Note**\n\u003e 🚧 Because of the algorithm's design, **multiple IDs can decode back into the same sequence of numbers**. If it's important to your design that IDs are canonical, you have to manually re-encode decoded numbers and check that the generated ID matches.\n\nEnforce a *minimum* length for IDs:\n\n```javascript\nimport Sqids from 'sqids'\n\nconst sqids = new Sqids({\n  minLength: 10,\n})\nconst id = sqids.encode([1, 2, 3]) // \"86Rf07xd4z\"\nconst numbers = sqids.decode(id) // [1, 2, 3]\n```\n\nRandomize IDs by providing a custom alphabet:\n\n```javascript\nimport Sqids from 'sqids'\n\nconst sqids = new Sqids({\n  alphabet: 'FxnXM1kBN6cuhsAvjW3Co7l2RePyY8DwaU04Tzt9fHQrqSVKdpimLGIJOgb5ZE',\n})\nconst id = sqids.encode([1, 2, 3]) // \"B4aajs\"\nconst numbers = sqids.decode(id) // [1, 2, 3]\n```\n\nPrevent specific words from appearing anywhere in the auto-generated IDs:\n\n```javascript\nimport Sqids from 'sqids'\n\nconst sqids = new Sqids({\n  blocklist: new Set(['86Rf07']),\n})\nconst id = sqids.encode([1, 2, 3]) // \"se8ojk\"\nconst numbers = sqids.decode(id) // [1, 2, 3]\n```\n\n## 📝 License\n\n[MIT](LICENSE)\n","funding_links":[],"categories":["TypeScript","ID \u0026 Unique IDs"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsqids%2Fsqids-javascript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsqids%2Fsqids-javascript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsqids%2Fsqids-javascript/lists"}