{"id":"csqrl/dump-parser","name":"dump-parser","scope":"csqrl","platform":"roblox","description":"Mirrored from the Wally registry.","version":"0.1.2","latest":"0.1.2","versions":["0.1.0","0.1.1","0.1.2"],"license":"MIT","licenseRating":"safe","licenseCaveats":["License identified from the packaged LICENSE file; the manifest declared none."],"licenseVerified":true,"dependencies":{},"integrity":"8018b724b632f0e27b635de8681fae76ea07407a7212b01b58f51b22f0821ab9","likes":0,"downloads":0,"install":"forest install csqrl/dump-parser","url":"https://forest.dev/p/roblox/csqrl/dump-parser","files":"https://api.forest.dev/ai/package/roblox/csqrl/dump-parser/files","readme":"# Dump Parser\n\nA generic parser for the Roblox API dump. Inspired by [@corecii](https://github.com/Corecii)'s\n[API Dump (Static)](https://github.com/corecii/api-dump-static) and\n[@raphtalia](https://github.com/raphtalia)'s [RobloxAPI](https://github.com/raphtalia/robloxapi)\nlibraries.\n\n## Documentation\n\nDocumentation can be found at https://csqrl.github.io/dump-parser.\n\n## Quick Start\n\nDump Parser is available via [Wally](https://wally.run).\n\n### Wally\n\n```toml\n# wally.toml\n\n[dependencies]\nDumpParser = \"csqrl/dump-parser@0.1.0\"\n```\n\n```bash\n$ wally install\n```\n\n### Manual Installation\n\nDownload a copy of the latest release from the GitHub repo,\nand compile it using Rojo. From there, you can drop the\nbinary directly into your project files or Roblox Studio.\n\n## Example Usage\n\n~~~lua\nlocal DumpParser = require(path.to.DumpParser)\nlocal Dump = DumpParser.fetchFromServer()\n\nlocal PartClass = Dump:GetClass(\"Part\")\n\n-- Get a list of all properties on \"Part\"\nprint(PartClass:GetProperties())\n\n--[[\n\tGet a list of safe-to-use properties on \"Part\". This is\n\tfunctionally equivalent to:\n\n\t```lua\n\tPartClass:GetProperties(\n\t\tFilter.Invert(Filter.Deprecated), -- Include non-deprecated\n\t\tFilter.HasSecurity(\"None\"), -- Include properties with no read/write security\n\t\tFilter.Scriptable -- Include properties that can be set in scripts\n\t)\n\t```\n\n\t`GetProperties`, `GetEvents`, `GetFunctions` and `GetCallbacks`\n\tall accept a variable number of filters as arguments. This\n\tallows you to filter down the list of results to only what\n\tyou need.\n--]]\nprint(Dump:GetProperties(\"Part\"))\n~~~\n","readmeTruncated":false}