An open API service indexing awesome lists of open source software.

https://github.com/bytebit-org/roblox-stacksandqueues

A simple set of implementations of stack and queue data structures.
https://github.com/bytebit-org/roblox-stacksandqueues

Last synced: 4 months ago
JSON representation

A simple set of implementations of stack and queue data structures.

Awesome Lists containing this project

README

        

# Stacks and Queues



CI status


PRs Welcome


License: MIT


Discord server

Stacks and Queues is a simple set of implementations of stack and queue data structures.

## Installation
### roblox-ts
Simply install to your [roblox-ts](https://roblox-ts.com/) project as follows:
```
npm i @rbxts/stacks-and-queues
```

### Wally
[Wally](https://github.com/UpliftGames/wally/) users can install this package by adding the following line to their `Wally.toml` under `[dependencies]`:
```
StacksAndQueues = "bytebit/[email protected]"
```

Then just run `wally install`.

### From model file
Model files are uploaded to every release as `.rbxmx` files. You can download the file from the [Releases page](https://github.com/Bytebit-Org/roblox-StacksAndQueues/releases) and load it into your project however you see fit.

### From model asset
New 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/9181293671/Stacks-and-Queues-Package)

## Documentation
Documentation can be found [here](https://github.com/Bytebit-Org/roblox-StacksAndQueues/tree/master/docs), is included in the TypeScript files directly, and was generated using [TypeDoc](https://typedoc.org/).

## Example
This example uses a `Queue` to track incoming tasks and attempts to process one every `RunService.Heartbeat` event.

roblox-ts example

```ts
import { Queue } from "@rbxts/stacks-and-queues";
import { RunService } from "@rbxts/services";

type Task = {}; // some task type

export class TaskProcessor {
private readonly queue = new Queue();

public constructor() {
this.listenForHeartbeats();
}

public queueTask(task: Task) {
this.queue.push(task);
}

private listenForHeartbeats() {
RunService.Heartbeat.Connect(() => {
if (this.queue.isEmpty()) {
return;
}

this.processTask(this.queue.pop());
});
}

private processTask(task: Task) {
// some processing stuff
}
}
```

Luau example

```lua
local RunService = game:GetService("RunService")

local Queue = require(path.to.modules["stacks-and-queues"]).Queue

local TaskProcessor = {}
TaskProcessor.__index = TaskProcessor

function new()
local self = {}
setmetatable(self, TaskProcessor)

self._queue = Queue.new()

_listenForHeartbeats(self)

return self
end

function TaskProcessor:queueTask(task)
self.queue:push(task)
end

function _listenForHeartbeats(self)
RunService.Heartbeat:Connect(function
if (self.queue:isEmpty()) then
return
end

_processTask(self, self.queue:pop())
end)
end

function _processTask(self, task)
-- some processing stuff
end

return {
new = new
}
```