Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/seaofvoices/luau-disk
Immutable data structures for Lua
https://github.com/seaofvoices/luau-disk
Last synced: 16 days ago
JSON representation
Immutable data structures for Lua
- Host: GitHub
- URL: https://github.com/seaofvoices/luau-disk
- Owner: seaofvoices
- License: mit
- Created: 2023-11-09T22:01:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-07T23:01:00.000Z (11 months ago)
- Last Synced: 2025-01-24T07:04:43.924Z (22 days ago)
- Language: Lua
- Size: 72.3 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-luau - `luau-disk` - disk?label=) | (Data)
README
# Disk
A collection of functions to operate on Lua/Luau data structures as immutable data.
# Installation
Add `luau-disk` in your dependencies:
```bash
yarn add luau-disk
```
Or if you are using `npm`:
```bash
npm install luau-disk
```
## Releases
Versions of Disk are also pre-built and linked to [GitHub releases](https://github.com/seaofvoices/luau-disk/releases):
- `disk.rbxm` is a Roblox model file
- `disk-bundled.lua` is a single-file version of the library (with Luau type annotations removed)
## Other Lua Environments Support
If you would like to use this library on a Lua environment, where it is currently incompatible, open an issue (or comment on an existing one) to request the appropriate modifications.
The library uses [darklua](https://github.com/seaofvoices/darklua) to process its code.
# Documentation
**Note:** Documentation has not been fully written yet.
Documentation available within the repository, under the `docs/` folder: [documentation](./docs/index.md).