{"id":34569065,"url":"https://github.com/notrab/libsql-rate-limit","last_synced_at":"2026-05-30T05:31:28.902Z","repository":{"id":264942661,"uuid":"860087617","full_name":"notrab/libsql-rate-limit","owner":"notrab","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-24T07:35:04.000Z","size":51,"stargazers_count":1,"open_issues_count":11,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-05-24T09:24:02.129Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/notrab.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":"2024-09-19T19:51:41.000Z","updated_at":"2024-09-21T02:01:12.000Z","dependencies_parsed_at":"2025-02-15T09:18:44.625Z","dependency_job_id":"a7952f0b-c8f7-47df-a39a-f6428505e8cb","html_url":"https://github.com/notrab/libsql-rate-limit","commit_stats":null,"previous_names":["notrab/libsql-rate-limit"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/notrab/libsql-rate-limit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notrab%2Flibsql-rate-limit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notrab%2Flibsql-rate-limit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notrab%2Flibsql-rate-limit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notrab%2Flibsql-rate-limit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/notrab","download_url":"https://codeload.github.com/notrab/libsql-rate-limit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/notrab%2Flibsql-rate-limit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33681809,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-30T02:00:06.278Z","response_time":92,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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-12-24T09:14:13.977Z","updated_at":"2026-05-30T05:31:28.885Z","avatar_url":"https://github.com/notrab.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rate Limit SDK\n\nJust playing...\n\n## Install\n\nInstall the package using npm:\n\n```bash\nnpm install libsql-rate-limit\n```\n\n## Usage\n\n```typescript\nimport { rateLimiter } from \"libsql-rate-limit\";\n\nasync function exampleUsage() {\n  try {\n    const result = await rateLimiter.limit({\n      key: \"user-123\", // Unique identifier for the rate limit\n      limit: 5, // Maximum number of requests allowed\n      window: 60000, // Time window in milliseconds (60 seconds in this case)\n    });\n\n    if (result.success) {\n      console.log(\"Request allowed\");\n      console.log(`Remaining requests: ${result.remaining}`);\n    } else {\n      console.log(\"Rate limit exceeded\");\n      console.log(`Try again in ${result.reset} ms`);\n    }\n  } catch (error) {\n    console.error(\"Rate limiting error:\", error);\n  }\n}\n\nexampleUsage();\n```\n\n### Custom Configuration\n\nIf you need to use a custom configuration, you can create a new rate limiter instance:\n\n```typescript\nimport { createRateLimiter } from \"libsql-rate-limit\";\n\nconst customRateLimiter = createRateLimiter({\n  url: \"libsql://your-database.turso.io\",\n  authToken: \"your-auth-token\",\n});\n\n// Use customRateLimiter.limit() as in the basic usage example\n```\n\n## Configuration\n\nThe SDK can be configured using environment variables or by passing a configuration object to `createRateLimiter`.\n\n### Environment Variables\n\n- `LIBSQL_URL`: The URL of your libSQL database (e.g., `libsql://your-database.turso.io` or `file:./your-local.db`)\n- `LIBSQL_AUTH_TOKEN`: The authentication token for your libSQL database (if using a remote db)\n\nIf no environment variables are detected, the SDK defaults to using a local SQLite file at `./rate-limit.db`.\n\n### Configuration Object\n\nWhen using `createRateLimiter`, you can pass a configuration object that includes any of the properties from the `Config` interface of `@libsql/client`. The most commonly used properties are:\n\n```typescript\ninterface RateLimitConfig {\n  url?: string;\n  authToken?: string;\n  // Other properties from @libsql/client's Config interface can be included as needed\n}\n```\n\nIf `url` is not provided in the config or environment variables, it defaults to `'file:./rate-limit.db'`.\n\n## API\n\n### `rateLimiter.limit(options: RateLimitOptions)`\n\nCheck and update the rate limit for a given key.\n\n- `options.key`: Unique identifier for the rate limit\n- `options.limit`: Maximum number of requests allowed\n- `options.window`: Time window in milliseconds\n\nReturns a `Promise\u003cRateLimitResult\u003e`:\n\n```typescript\ninterface RateLimitResult {\n  success: boolean; // Whether the request is allowed\n  limit: number; // The maximum number of requests allowed\n  remaining: number; // The number of requests remaining in the current window\n  reset: number; // The number of milliseconds until the limit resets\n}\n```\n\n### `createRateLimiter(config: RateLimitConfig)`\n\nCreate a new RateLimiter instance with custom configuration.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotrab%2Flibsql-rate-limit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnotrab%2Flibsql-rate-limit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnotrab%2Flibsql-rate-limit/lists"}