{"id":23790024,"url":"https://github.com/blackglory/stream","last_synced_at":"2025-12-30T21:09:26.070Z","repository":{"id":222611750,"uuid":"617412102","full_name":"BlackGlory/stream","owner":"BlackGlory","description":"🌿","archived":false,"fork":false,"pushed_at":"2024-02-15T07:51:21.000Z","size":215,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-11T19:33:36.490Z","etag":null,"topics":["docker-image","esm","microservice","nodejs","typescript"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/blackglory/stream","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}},"created_at":"2023-03-22T10:41:36.000Z","updated_at":"2023-03-26T18:20:04.000Z","dependencies_parsed_at":"2024-02-15T08:50:51.045Z","dependency_job_id":null,"html_url":"https://github.com/BlackGlory/stream","commit_stats":null,"previous_names":["blackglory/stream"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/BlackGlory/stream","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlackGlory%2Fstream","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlackGlory%2Fstream/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlackGlory%2Fstream/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlackGlory%2Fstream/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BlackGlory","download_url":"https://codeload.github.com/BlackGlory/stream/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlackGlory%2Fstream/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279008424,"owners_count":26084460,"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","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"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":["docker-image","esm","microservice","nodejs","typescript"],"created_at":"2025-01-01T17:18:08.808Z","updated_at":"2025-10-11T19:33:37.003Z","avatar_url":"https://github.com/BlackGlory.png","language":"TypeScript","readme":"# Stream\n提供基于HTTP的流数据传输中介服务.\n\n## Install\n### 从源代码运行\n```sh\ngit clone https://github.com/BlackGlory/stream\ncd stream\nyarn install\nyarn build\nyarn bundle\nyarn --silent start\n```\n\n### 从源代码构建\n```sh\ngit clone https://github.com/BlackGlory/stream\ncd stream\nyarn install\nyarn docker:build\n```\n\n### Recipes\n#### docker-compose.yml\n```yaml\nversion: '3.8'\n\nservices:\n  pubsub:\n    image: 'blackglory/stream'\n    restart: always\n    ports:\n      - '8080:8080'\n```\n\n## API\n### create stream\n`PUT /streams/\u003cid\u003e`\n\n创建一个流.\n\n发送JSON:\n```ts\n{\n  // 设置流的存活时间, 以流创建起开始计时, 超时会自动关闭.\n  // 如果流被删除时正在被使用, 流的写入者和读取者都会被断开连接.\n  // null表示不限制.\n  timeToLive: number | null\n}\n```\n\n每个流都是双向的, 可以上传也可以下载.\n在流的生命周期中, 创建, 写入, 读取操作各自只能被执行一次.\n\n如果流已经被创建, 返回409.\n\n#### Example\n##### curl\n```sh\ncurl \\\n  --request PUT \\\n  --header \"Content-Type: application/json\" \\\n  --data \"$payload\" \\\n  \"http://localhost:8080/streams/$id\"\n```\n\n##### JavaScript\n```js\nawait fetch(`http://localhost:8080/streams/${id}`, {\n  method: 'PUT'\n, headers: {\n    'Content-Type': 'application/json'\n  }\n, body: JSON.stringify(payload)\n})\n```\n\n### write stream\n`POST /streams/\u003cid\u003e`\n\n写入流.\n\n如果流不存在, 返回404.\n如果流已经被其他客户端抢先写入, 返回409.\n\n#### Example\n##### curl\n```sh\ncurl \\\n  --request POST \\\n  --data-binary \"$payload\" \\\n  \"http://localhost:8080/streams/$id\"\n```\n\n##### JavaScript\n```js\nawait fetch(`http://localhost:8080/streams/${id}`, {\n  method: 'POST'\n, headers: {\n    'Content-Type': 'application/octet-stream'\n  }\n, body: payload\n})\n```\n\n### read stream\n`GET /streams/\u003cid\u003e`\n\n读取流.\n\n如果流不存在, 返回404.\n如果流已经被其他客户端抢先读取, 返回409.\n\n#### Example\n##### curl\n```sh\ncurl --no-buffer \\\n  \"http://localhost:8080/streams/$id\"\n```\n\n##### JavaScript\n```js\nawait fetch(`http://localhost:8080/streams/${id}`)\n  .then(res =\u003e res.body)\n```\n\n## 环境变量\n### `STREAM_HOST`, `STREAM_PORT`\n通过环境变量`STREAM_HOST`和`STREAM_PORT`决定服务器监听的地址和端口,\n默认值为`localhost`和`8080`.\n\n## 客户端\n- JavaScript/TypeScript(Node.js, Browser): \u003chttps://github.com/BlackGlory/stream-js\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblackglory%2Fstream","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblackglory%2Fstream","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblackglory%2Fstream/lists"}