{"id":23789925,"url":"https://github.com/blackglory/geyser","last_synced_at":"2026-04-28T12:34:40.022Z","repository":{"id":44955863,"uuid":"347942935","full_name":"BlackGlory/geyser","owner":"BlackGlory","description":"🌲","archived":false,"fork":false,"pushed_at":"2024-12-28T10:29:35.000Z","size":1706,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-12-28T11:23:49.107Z","etag":null,"topics":["docker-image","esm","microservice","nodejs","typescript"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/blackglory/geyser","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/BlackGlory.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":"2021-03-15T11:29:53.000Z","updated_at":"2024-12-28T10:29:39.000Z","dependencies_parsed_at":"2024-01-04T19:40:39.340Z","dependency_job_id":"bc7492a1-c705-4ccc-a19a-fc5376c72478","html_url":"https://github.com/BlackGlory/geyser","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlackGlory%2Fgeyser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlackGlory%2Fgeyser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlackGlory%2Fgeyser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlackGlory%2Fgeyser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BlackGlory","download_url":"https://codeload.github.com/BlackGlory/geyser/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240018691,"owners_count":19734872,"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":["docker-image","esm","microservice","nodejs","typescript"],"created_at":"2025-01-01T17:17:42.655Z","updated_at":"2026-04-28T12:34:40.015Z","avatar_url":"https://github.com/BlackGlory.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# geyser\n提供以WebSocket为通讯协议的咨询式速率限制器.\n\n## Quickstart\n```sh\ndocker run \\\n  --detach \\\n  --publish 8080:8080 \\\n  blackglory/geyser\n```\n\n## Install\n### 从源代码运行\n```sh\ngit clone https://github.com/BlackGlory/geyser\ncd geyser\nyarn install\nyarn build\nyarn bundle\nyarn --silent start\n```\n\n### 从源代码构建\n```sh\ngit clone https://github.com/BlackGlory/geyser\ncd geyser\nyarn install\nyarn docker:build\n```\n\n### Recipes\n#### docker-compose.yml\n```yaml\nversion: '3.8'\n\nservices:\n  geyser:\n    image: 'blackglory/geyser'\n    restart: always\n    volumes:\n      - 'geyser-data:/data'\n    ports:\n      - '8080:8080'\n\nvolumes:\n  geyser-data:\n```\n\n## API\n```ts\ninterface IRateLimiterConfig extends JSONObject {\n  duration: number | null /* 毫秒 */\n  limit: number | null\n}\n\ninterface IAPI {\n  getAllRateLimiterIds(): string[]\n\n  getRateLimiter(rateLimiterId: string): IRateLimiterConfig | null\n  setRateLimiter(rateLimiterId: string, config: IRateLimiterConfig): null\n  removeRateLimiter(rateLimiterId: string): null\n\n  /**\n   * 重置速率限制器的状态.\n   * \n   * @throws {RateLimiterNotFound}\n   */\n  resetRateLimiter(rateLimiterId: string): null\n\n  /**\n   * @throws {RateLimiterNotFound}\n   */\n  acquireToken(rateLimiterId: string): null\n}\n\n/**\n * 速率限制器在未经配置的情况下, 相当于不存在.\n */\nclass RateLimiterNotFound extends CustomError {}\n```\n\n## 环境变量\n### `GEYSER_HOST`, `GEYSER_PORT`\n通过环境变量`GEYSER_HOST`和`GEYSER_PORT`决定服务器监听的地址和端口,\n默认值为`localhost`和`8080`.\n\n### `GEYSER_WS_HEARTBEAT_INTERVAL`\n通过环境变量`GEYSER_WS_HEARTBEAT_INTERVAL`可以设置WS心跳包(ping帧)的发送间隔, 单位为毫秒.\n在默认情况下, 服务不会发送心跳包,\n半开连接的检测依赖于服务端和客户端的运行平台的TCP Keepalive配置.\n\n当`GEYSER_WS_HEARTBEAT_INTERVAL`大于零时,\n服务会通过WS的ping帧按间隔发送心跳包.\n\n## 客户端\n- JavaScript/TypeScript(Node.js, Browser): \u003chttps://github.com/BlackGlory/geyser-js\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblackglory%2Fgeyser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblackglory%2Fgeyser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblackglory%2Fgeyser/lists"}