{"id":28956578,"url":"https://github.com/tknf/snowflake","last_synced_at":"2026-03-10T21:32:39.267Z","repository":{"id":299453013,"uuid":"1003112174","full_name":"tknf/snowflake","owner":"tknf","description":"A zero-dependency TypeScript library for generating sortable unique IDs for distributed systems","archived":false,"fork":false,"pushed_at":"2025-06-17T14:14:41.000Z","size":397,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-05T03:00:25.479Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/tknf.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-06-16T16:34:04.000Z","updated_at":"2025-06-17T14:15:01.000Z","dependencies_parsed_at":"2025-06-16T17:07:29.488Z","dependency_job_id":"0730ab74-db03-40ac-a9e4-3682c76de3d6","html_url":"https://github.com/tknf/snowflake","commit_stats":null,"previous_names":["tknf/snowflake"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/tknf/snowflake","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tknf%2Fsnowflake","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tknf%2Fsnowflake/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tknf%2Fsnowflake/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tknf%2Fsnowflake/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tknf","download_url":"https://codeload.github.com/tknf/snowflake/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tknf%2Fsnowflake/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30355656,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-10T15:55:29.454Z","status":"ssl_error","status_checked_at":"2026-03-10T15:54:58.440Z","response_time":106,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2025-06-23T21:30:38.815Z","updated_at":"2026-03-10T21:32:39.240Z","avatar_url":"https://github.com/tknf.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tknf/snowflake/main/docs/snowflake.png\" alt=\"Snowflake Logo\" width=\"250\" height=\"auto\"\u003e\n  \u003ch1\u003e@tknf/snowflake\u003c/h1\u003e\n  \u003cp\u003eA zero-dependency TypeScript library for generating sortable unique IDs for distributed systems\u003c/p\u003e\n\u003c/div\u003e\n\n\u003chr /\u003e\n\n[![Github Workflow Status](https://img.shields.io/github/actions/workflow/status/tknf/snowflake/ci.yaml?branch=main)](https://github.com/tknf/snowflake/actions)\n[![Github](https://img.shields.io/github/license/tknf/snowflake)](https://github.com/tknf/snowflake/blob/main/LICENSE)\n[![npm](https://img.shields.io/npm/v/@tknf/snowflake)](https://www.npmjs.com/package/@tknf/snowflake)\n[![npm bundle size](https://img.shields.io/bundlephobia/min/@tknf/snowflake)](https://bundlephobia.com/package/@tknf/snowflake)\n[![npm bundle size](https://img.shields.io/bundlephobia/minzip/@tknf/snowflake)](https://bundlephobia.com/package/@tknf/snowflake)\n[![Github commit activity](https://img.shields.io/github/commit-activity/m/tknf/snowflake)](https://github.com/tknf/snowflake/pulse)\n[![GitHub last commit](https://img.shields.io/github/last-commit/tknf/snowflake)](https://github.com/tknf/snowflake/commits/main)\n[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/tknf/snowflake)\n\n## ✨ Features\n\n- **Multi-platform Support**: Works in browsers, Node.js, Service Workers, and Edge Workers (Cloudflare Workers, etc.)\n- **Zero Dependencies**: Lightweight with no external dependencies\n- **Functional Style**: Pure functions without classes\n- **Time-sortable**: IDs are chronologically sortable\n- **High Performance**: Fast ID generation with built-in sequence handling\n- **TypeScript**: Full type support with comprehensive type definitions\n- **Service Worker Support**: Generate IDs in background contexts without blocking the main thread\n\n## 📦 Installation\n\n```bash\nnpm install @tknf/snowflake\n```\n\n## 🚀 Quick Start\n\n### Basic Usage\n\n```typescript\nimport { createSnowflake, generateSnowflakeId } from '@tknf/snowflake';\n\n// Create a generator function\nconst generateId = createSnowflake();\nconst id1 = generateId(); // \"1234567890123456789\"\nconst id2 = generateId(); // \"1234567890123456790\"\n\n// Or generate a single ID\nconst id = generateSnowflakeId(); // \"1234567890123456791\"\n```\n\n### Custom Configuration\n\n```typescript\nimport { createSnowflake } from '@tknf/snowflake';\n\nconst generateId = createSnowflake({\n  epoch: 1640995200000,     // Custom epoch (2022-01-01)\n  datacenterId: 1,          // Datacenter ID (0-31)\n  workerId: 5               // Worker ID (0-31)\n});\n\nconst id = generateId();\n```\n\n### Node.js Environment Variables\n\n```typescript\n// src/node.ts - Node.js specific utilities\nimport { createSnowflakeFromEnv, generateFromEnv } from '@tknf/snowflake/node';\n\n// Set environment variables\nprocess.env.SNOWFLAKE_EPOCH = '1640995200000';\nprocess.env.SNOWFLAKE_DATACENTER_ID = '1';\nprocess.env.SNOWFLAKE_WORKER_ID = '5';\n\n// Create generator from environment\nconst generateId = createSnowflakeFromEnv();\nconst id1 = generateId();\n\n// Or generate single ID from environment\nconst id2 = generateFromEnv();\n\n// Override environment with custom config\nconst id3 = generateFromEnv({ workerId: 10 });\n```\n\n### Browser Usage\n\n```typescript\n// src/browser.ts - Browser specific utilities\nimport { \n  createSnowflakeFromStorage, \n  generateFromStorage,\n  initializeBrowserConfig,\n  saveConfigToStorage \n} from '@tknf/snowflake/browser';\n\n// Initialize browser-specific config (auto-generated from browser characteristics)\nconst config = initializeBrowserConfig({ \n  save: true, // Save to localStorage\n  config: { epoch: 1640995200000 } // Optional custom config\n});\n\n// Create generator using localStorage + browser fingerprint\nconst generateId = createSnowflakeFromStorage();\nconst id1 = generateId();\n\n// Or generate single ID from storage\nconst id2 = generateFromStorage();\n\n// Manual config management\nsaveConfigToStorage({ datacenterId: 5, workerId: 10 });\nconst id3 = generateFromStorage();\n```\n\n## 📚 API Reference\n\n### Core Functions\n\n#### `createSnowflake(config?)`\n\nCreates a Snowflake ID generator function.\n\n**Parameters:**\n- `config` (optional): Configuration object\n  - `epoch` (number): Custom epoch timestamp in milliseconds (default: 2020-01-01)\n  - `datacenterId` (number): Datacenter ID (0-31, default: 0)\n  - `workerId` (number): Worker ID (0-31, default: 0)\n\n**Returns:** Function that generates Snowflake IDs as strings\n\n```typescript\nconst generator = createSnowflake({\n  epoch: 1577836800000,\n  datacenterId: 1,\n  workerId: 2\n});\n\nconst id = generator(); // \"1234567890123456789\"\n```\n\n#### `generateSnowflakeId(config?)`\n\nGenerates a single Snowflake ID.\n\n**Parameters:**\n- `config` (optional): Same as `createSnowflake`\n\n**Returns:** Snowflake ID as string\n\n```typescript\nconst id = generateSnowflakeId({\n  datacenterId: 1,\n  workerId: 2\n});\n```\n\n#### `parseSnowflakeId(id, epoch?)`\n\nParses a Snowflake ID into its components.\n\n**Parameters:**\n- `id` (string): Snowflake ID to parse\n- `epoch` (number, optional): Epoch used for generation (default: 2020-01-01)\n\n**Returns:** Object containing:\n- `timestamp` (number): Generation timestamp\n- `datacenterId` (number): Datacenter ID\n- `workerId` (number): Worker ID\n- `sequence` (number): Sequence number\n- `date` (Date): Generation date\n\n```typescript\nconst parsed = parseSnowflakeId(\"1234567890123456789\");\nconsole.log(parsed);\n// {\n//   timestamp: 1640995200123,\n//   datacenterId: 1,\n//   workerId: 2,\n//   sequence: 0,\n//   date: 2022-01-01T00:00:00.123Z\n// }\n```\n\n#### `getSnowflakeTimestamp(id, epoch?)`\n\nExtracts timestamp from a Snowflake ID.\n\n**Parameters:**\n- `id` (string): Snowflake ID\n- `epoch` (number, optional): Epoch used for generation\n\n**Returns:** Timestamp in milliseconds\n\n```typescript\nconst timestamp = getSnowflakeTimestamp(\"1234567890123456789\");\nconsole.log(timestamp); // 1640995200123\n```\n\n#### `snowflakeToDate(id, epoch?)`\n\nConverts a Snowflake ID to a Date object.\n\n**Parameters:**\n- `id` (string): Snowflake ID\n- `epoch` (number, optional): Epoch used for generation\n\n**Returns:** Date object\n\n```typescript\nconst date = snowflakeToDate(\"1234567890123456789\");\nconsole.log(date); // 2022-01-01T00:00:00.123Z\n```\n\n### Node.js Utilities\n\nImport from `@tknf/snowflake/node` for Node.js-specific features:\n\n#### Environment Variables\n\n- `SNOWFLAKE_EPOCH`: Custom epoch timestamp\n- `SNOWFLAKE_DATACENTER_ID`: Datacenter ID (0-31)\n- `SNOWFLAKE_WORKER_ID`: Worker ID (0-31)\n\n#### `loadConfigFromEnv()`\n\nLoads configuration from environment variables.\n\n```typescript\nconst config = loadConfigFromEnv();\n// Returns SnowflakeConfig object based on environment variables\n```\n\n#### `createSnowflakeFromEnv(overrides?)`\n\nCreates a generator with environment configuration.\n\n```typescript\nconst generator = createSnowflakeFromEnv({ workerId: 5 });\n```\n\n#### `generateFromEnv(overrides?)`\n\nGenerates a single ID with environment configuration.\n\n```typescript\nconst id = generateFromEnv({ datacenterId: 2 });\n```\n\n### Browser Utilities\n\nImport from `@tknf/snowflake/browser` for browser-specific features:\n\n#### LocalStorage Keys\n\n- `snowflake.epoch`: Custom epoch timestamp\n- `snowflake.datacenterId`: Datacenter ID (0-31)\n- `snowflake.workerId`: Worker ID (0-31)\n\n#### `generateBrowserConfig()`\n\nGenerates browser-specific configuration based on browser characteristics (user agent, timezone, screen properties, etc.).\n\n```typescript\nconst config = generateBrowserConfig();\n// Returns consistent config for the same browser environment\n```\n\n#### `loadConfigFromStorage()`\n\nLoads configuration from localStorage.\n\n```typescript\nconst config = loadConfigFromStorage();\n// Returns SnowflakeConfig object from localStorage\n```\n\n#### `saveConfigToStorage(config)`\n\nSaves configuration to localStorage.\n\n```typescript\nsaveConfigToStorage({ datacenterId: 5, workerId: 10 });\n```\n\n#### `createSnowflakeFromStorage(overrides?)`\n\nCreates a generator with localStorage configuration and browser fingerprinting fallback.\n\n```typescript\nconst generator = createSnowflakeFromStorage({ epoch: 1640995200000 });\n```\n\n#### `generateFromStorage(overrides?)`\n\nGenerates a single ID with localStorage configuration.\n\n```typescript\nconst id = generateFromStorage({ workerId: 15 });\n```\n\n#### `initializeBrowserConfig(options?)`\n\nInitializes browser-specific configuration with optional localStorage persistence.\n\n**Parameters:**\n- `options.save` (boolean): Whether to save to localStorage (default: false)\n- `options.config` (SnowflakeConfig): Custom configuration to merge\n\n```typescript\nconst config = initializeBrowserConfig({\n  save: true,\n  config: { epoch: 1640995200000 }\n});\n```\n\n#### `clearStoredConfig()`\n\nClears all stored configuration from localStorage.\n\n```typescript\nclearStoredConfig();\n```\n\n#### `getBrowserFingerprint()`\n\nGets detailed browser fingerprint for debugging purposes.\n\n```typescript\nconst fingerprint = getBrowserFingerprint();\n// Returns object with datacenterId, workerId, timezone, userAgent, screen info, etc.\n```\n\n## ID Format\n\nSnowflake IDs are 64-bit integers composed of:\n\n```\n 1 bit   |  41 bits  |  5 bits   |  5 bits  | 12 bits\nunused   | timestamp | datacenter| worker   | sequence\n```\n\n- **Timestamp (41 bits)**: Milliseconds since custom epoch\n- **Datacenter ID (5 bits)**: Identifies the datacenter (0-31)\n- **Worker ID (5 bits)**: Identifies the worker process (0-31)  \n- **Sequence (12 bits)**: Counter for same-millisecond generation (0-4095)\n\n## 💡 Examples\n\n### High-Frequency Generation\n\n```typescript\nconst generator = createSnowflake({ workerId: 1 });\n\n// Generate 1000 IDs quickly\nconst ids = [];\nfor (let i = 0; i \u003c 1000; i++) {\n  ids.push(generator());\n}\n\n// All IDs are unique and sortable\nconsole.log(ids.length === new Set(ids).size); // true\n```\n\n### Multiple Workers\n\n```typescript\nconst worker1 = createSnowflake({ workerId: 1 });\nconst worker2 = createSnowflake({ workerId: 2 });\n\nconst id1 = worker1(); // From worker 1\nconst id2 = worker2(); // From worker 2\n\n// IDs from different workers are still unique\nconsole.log(id1 !== id2); // true\n```\n\n### Browser Application\n\n```typescript\n// React/Vue/etc. application\nimport { initializeBrowserConfig, createSnowflakeFromStorage } from '@tknf/snowflake/browser';\n\n// Initialize on app startup\nconst config = initializeBrowserConfig({ \n  save: true, // Persist across browser sessions\n  config: { epoch: 1640995200000 }\n});\n\nconst generator = createSnowflakeFromStorage();\n\n// Use in your app\nfunction createNewRecord() {\n  const id = generator();\n  console.log('New record ID:', id);\n  return id;\n}\n```\n\n### Service Workers\n\n```typescript\n// Service Worker example\n// sw.js\nimportScripts('https://unpkg.com/@tknf/snowflake/dist/snowflake.min.js');\n\nself.addEventListener('message', (event) =\u003e {\n  if (event.data.type === 'GENERATE_ID') {\n    const generator = Snowflake.createSnowflake({\n      datacenterId: 1,\n      workerId: 5\n    });\n    \n    const id = generator();\n    \n    // Send back to main thread\n    self.clients.matchAll().then(clients =\u003e {\n      for (const client of clients) {\n        client.postMessage({\n          type: 'ID_GENERATED',\n          data: { id }\n        });\n      }\n    });\n  }\n});\n\n// Main thread\nnavigator.serviceWorker.controller.postMessage({\n  type: 'GENERATE_ID'\n});\n```\n\n### Cloudflare Workers\n\n```typescript\n// Cloudflare Worker example\nexport default {\n  async fetch(request: Request, env: Env): Promise\u003cResponse\u003e {\n    const generator = createSnowflake({\n      datacenterId: 1,\n      workerId: parseInt(env.WORKER_ID) || 0\n    });\n    \n    const id = generator();\n    \n    return new Response(JSON.stringify({ id }), {\n      headers: { 'Content-Type': 'application/json' }\n    });\n  }\n};\n```\n\n### Browser Fingerprinting\n\n```typescript\nimport { getBrowserFingerprint, generateBrowserConfig } from '@tknf/snowflake/browser';\n\n// Get detailed browser information\nconst fingerprint = getBrowserFingerprint();\nconsole.log('Browser fingerprint:', fingerprint);\n\n// Consistent config for same browser\nconst config1 = generateBrowserConfig();\nconst config2 = generateBrowserConfig();\nconsole.log(config1.workerId === config2.workerId); // true - same browser = same workerId\n```\n\n## Example Usage\n\nThe library includes comprehensive examples for different environments:\n\n- **`examples/iife/`**: IIFE browser example with localStorage integration\n- **`examples/node/`**: Node.js example with environment variables\n- **`examples/worker/`**: Service Worker example with background generation\n\nEach example includes:\n- Complete working code\n- Performance testing\n- Error handling\n- Detailed README with setup instructions\n\n### Running Examples\n\n```bash\n# IIFE Browser Example\ncd examples/iife\npnpm install\npnpm run start\n\n# Node.js Example  \ncd examples/node\npnpm install\npnpm run start\n\n# Service Worker Example\ncd examples/worker\npnpm install\npnpm run start\n```\n\n## 🛠️ Development\n\n### Setup\n\n```bash\ngit clone git@github.com:tknf/snowflake.git\ncd snowflake\npnpm install\n```\n\n### Scripts\n\n```bash\n# Build the library\npnpm run build\n\n# Run tests\npnpm run test\n\n# Run tests with coverage\npnpm run test:coverage\n\n# Lint code\npnpm run lint\n\n# Format code\npnpm run format\n\n# Type check\npnpm run typecheck\n```\n\n### Project Structure\n\n```\nsrc/\n├── index.ts         # Core Snowflake logic (platform-agnostic)\n├── node.ts          # Node.js-specific utilities\n├── browser.ts       # Browser-specific utilities\n├── iife.ts          # IIFE build for browser usage\n├── index.test.ts    # Core functionality tests\n├── node.test.ts     # Node.js utilities tests\n└── browser.test.ts  # Browser utilities tests\n\nexamples/\n├── iife/            # IIFE browser example\n├── node/            # Node.js example\n└── worker/          # Service Worker example\n```\n\n## 🔧 Requirements\n\n- **Runtime**: No runtime dependencies\n- **Development**: Node.js 18+ for building and testing\n- **TypeScript**: Full type support included\n\n## 📄 License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n\n## 🤝 Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Ensure tests pass: `pnpm run test`\n5. Ensure linting passes: `pnpm run lint`\n6. Submit a pull request\n\n## 🙏 Acknowledgments\n\nThis implementation follows the distributed ID generation pattern, designed for high-performance unique ID generation in distributed systems.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftknf%2Fsnowflake","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftknf%2Fsnowflake","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftknf%2Fsnowflake/lists"}