{"id":18809901,"url":"https://github.com/bytebit-org/roblox-batchcollector","last_synced_at":"2026-01-10T12:30:15.818Z","repository":{"id":57683529,"uuid":"472520395","full_name":"Bytebit-Org/roblox-BatchCollector","owner":"Bytebit-Org","description":"A module for collecting batches of items, be they logs or tasks, to be posted together in order.","archived":false,"fork":false,"pushed_at":"2022-04-05T05:19:01.000Z","size":223,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-30T04:45:40.556Z","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/Bytebit-Org.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}},"created_at":"2022-03-21T21:36:19.000Z","updated_at":"2022-03-21T21:57:30.000Z","dependencies_parsed_at":"2022-09-05T16:50:34.879Z","dependency_job_id":null,"html_url":"https://github.com/Bytebit-Org/roblox-BatchCollector","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bytebit-Org%2Froblox-BatchCollector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bytebit-Org%2Froblox-BatchCollector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bytebit-Org%2Froblox-BatchCollector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bytebit-Org%2Froblox-BatchCollector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Bytebit-Org","download_url":"https://codeload.github.com/Bytebit-Org/roblox-BatchCollector/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239743880,"owners_count":19689563,"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":[],"created_at":"2024-11-07T23:18:08.447Z","updated_at":"2026-01-10T12:30:15.720Z","avatar_url":"https://github.com/Bytebit-Org.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Batch Collector\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/Bytebit-Org/roblox-BatchCollector/actions\"\u003e\n      \u003cimg src=\"https://github.com/Bytebit-Org/roblox-BatchCollector/workflows/CI/badge.svg\" alt=\"CI status\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"http://makeapullrequest.com\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/PRs-welcome-blue.svg\" alt=\"PRs Welcome\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/License-MIT-blue.svg\" alt=\"License: MIT\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://discord.gg/QEz3v8y\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord\u0026longCache=true\u0026style=flat\" alt=\"Discord server\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nBatch Collector is a module for collecting batches of items, be they logs or tasks, to be posted together in order.\n\n## Installation\n### roblox-ts\nSimply install to your [roblox-ts](https://roblox-ts.com/) project as follows:\n```\nnpm i @rbxts/batch-collector\n```\n\n### Wally\n[Wally](https://github.com/UpliftGames/wally/) users can install this package by adding the following line to their `Wally.toml` under `[dependencies]`:\n```\nBatchCollector = \"bytebit/batch-collector@1.0.3\"\n```\n\nThen just run `wally install`.\n\n### From model file\nModel files are uploaded to every release as `.rbxmx` files. You can download the file from the [Releases page](https://github.com/Bytebit-Org/roblox-BatchCollector/releases) and load it into your project however you see fit.\n\n### From model asset\nNew versions of the asset are uploaded with every release. The asset can be added to your Roblox Inventory and then inserted into your Place via Toolbox by getting it [here.](https://www.roblox.com/library/9165031169/Batch-Collector-Package)\n\n## Documentation\nDocumentation can be found [here](https://github.com/Bytebit-Org/roblox-BatchCollector/tree/master/docs), is included in the TypeScript files directly, and was generated using [TypeDoc](https://typedoc.org/).\n\n## Example\nWe'll write a class that uses a `BatchCollector` to collect in-game events that will then be sent to a backend server that tracks all events across all servers and allows them to be viewed by a developer in some sort of dashboard.\n\n\u003cdetails\u003e\n  \u003csummary\u003eroblox-ts example\u003c/summary\u003e\n\n  ```ts\n  import { BatchCollector, BatchPostRateLimitingConfiguration, IBatchCollector } from \"@rbxts/batch-collector\";\n\n  type GameEvent = {\n    readonly eventTypeName: string\n  };\n\n  const batchPostRateLimitingConfiguration: BatchPostRateLimitingConfiguration = {\n    maxNumberOfItems: 50; // don't want too many events at once\n    maxTimeBetweenPostsInSeconds: 30; // don't want too much of a time discrepancy\n    minTimeBetweenPostsInSeconds: 10; // want to make sure we don't send too many and hit the HttpService limits\n  };\n\n  export class GameEventsPoster {\n    private readonly batchCollector: IBatchCollector\u003cGameEvent\u003e;\n\n    public constructor() {\n      this.batchCollector = BatchCollector.create(\n        (gameEventsBatch) =\u003e this.postGameEvents(gameEventsBatch),\n        batchPostRateLimitingConfiguration,\n      );\n    }\n\n    public logGameEvent(gameEvent: GameEvent) {\n      this.batchCollector.pushItem(gameEvent);\n    }\n\n    private postGameEvents(gameEvents: ReadonlyArray\u003cGameEvent\u003e) {\n      // logic to post game events to backend server using HttpService\n    }\n  }\n  ```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eLuau example\u003c/summary\u003e\n\n  ```lua\n  local BatchCollector = require(path.to.modules[\"batch-collector\"]).BatchCollector\n\n  local batchPostRateLimitingConfiguration = {\n    maxNumberOfItems = 50, -- don't want too many events at once\n    maxTimeBetweenPostsInSeconds = 30, -- don't want too much of a time discrepancy\n    minTimeBetweenPostsInSeconds = 10 -- want to make sure we don't send too many and hit the HttpService limits\n  }\n\n  local GameEventsPoster = {}\n  GameEventsPoster.__index = GameEventsPoster\n\n  function new()\n    local self = {}\n    setmetatable(self, GameEventsPoster)\n\n    self.batchCollector = BatchCollector.create(\n      function (gameEventsBatch)\n        _postGameEvents(self, gameEventsBatch)\n      end,\n      batchPostRateLimitingConfiguration\n    )\n\n    return self\n  end\n\n  function GameEventsPoster:logGameEvent(gameEvent)\n    self.batchCollector(pushItem(gameEvent))\n  end\n\n  function _postGameEvents(self, gameEventsBatch)\n    -- logic to post game events to backend server using HttpService\n  end\n\n  return {\n    new = new\n  }\n  ```\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbytebit-org%2Froblox-batchcollector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbytebit-org%2Froblox-batchcollector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbytebit-org%2Froblox-batchcollector/lists"}