{"id":"zentiph/luautils","name":"luautils","scope":"zentiph","platform":"roblox","description":"A Luau utilities library; an extension of Luau's standard library","version":"0.1.3","latest":"0.1.3","versions":["0.1.1","0.1.2","0.1.3"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":true,"dependencies":{},"integrity":"c21b3f37721ba3c6f4e40616476e1eea864af9c47e603c5806a2b2fb9d98fa01","likes":0,"downloads":0,"install":"forest install zentiph/luautils","url":"https://forest.dev/p/roblox/zentiph/luautils","files":"https://api.forest.dev/ai/package/roblox/zentiph/luautils/files","readme":"# luautils\n\nA Luau utilities library written for a wide variety of general use cases.\nLuautils strives to act as an extension of Luau's standard library.\n\nThis library is heavily inspired by standard libraries of other languages such\nas Rust and Java.\n\n## Contents\n\n| Sublibrary | Contains                                                 |\n| ---------- | -------------------------------------------------------- |\n| `Core`     | `Option`, `Result`, `Errors`, `Values`, and shared types |\n| `Time`     | `Duration`, `Stopwatch`, `Cooldown`                      |\n| `Tables`   | `deepCopy`                                               |\n| `Async`    | `retry`                                                  |\n\n`Collections`, `Math`, `Strings`, `Validation`, `Events`, and `Roblox` are\nplanned and currently empty.\n\n## Installation\n\n### ROBLOX\n\nFor use in ROBLOX projects, Wally is the recommended installation method.\n\nGet the latest version:\n\n```bash\nwally search luautils\n```\n\nAdd it to your `wally.toml`:\n\n```toml\n[dependencies]\nLuautils = \"zentiph/luautils@<version>\"\n```\n\nThen require it:\n\n```lua\nlocal Luautils = require(game:GetService(\"ReplicatedStorage\").Packages.Luautils)\n```\n\n### Standalone Luau\n\nFor standalone Luau projects, such as Lute, pesde is the recommended method:\n\n```bash\npesde add zentiph/luautils\npesde install\n```\n\nThe pesde release targets luau only.\n[ROBLOX projects should use Wally](#roblox).\n\n### Manually\n\nClone the repository:\n\n```bash\ngit clone https://github.com/Zentiph/luautils.git\n```\n\nBuild the library into a model file with Rojo, then insert it into your place:\n\n```bash\nrojo build -o luautils.rbxm\n```\n\nOr sync it live into ROBLOX Studio, where it appears as the\n`ReplicatedStorage/Luautils` `ModuleScript`:\n\n```bash\nrojo serve dev.project.json\n```\n\nThen require it:\n\n```lua\nlocal Luautils = require(game:GetService(\"ReplicatedStorage\").Luautils)\nlocal Option = Luautils.Core.Option\n```\n\n### Verifying your copy\n\nThe tools used by this project are pinned in `rokit.toml`.\nTo install them and run every check (formatting, linting, type checking, and\ntests), run the following from the repository root:\n\n```bash\nrokit install\nlute setup\nlute run .lute/ci.luau\n```\n\n## Documentation\n\nThe API documentation is hosted on GitHub Pages at\n[zentiph.github.io/luautils](https://zentiph.github.io/luautils/), and is\nrebuilt from `master` on every push that passes CI.\n\nIt is written as Moonwave doc comments in the source.\nTo preview it locally:\n\n```bash\nmoonwave dev\n```\n\n## Contributing\n\nSee\n[CONTRIBUTING.md](https://github.com/Zentiph/luautils/blob/master/CONTRIBUTING.md)\nfor development setup, the CI checks, and the conventions used throughout the\nlibrary.","readmeTruncated":false}