{"id":"corecii/api-dump-static","name":"api-dump-static","scope":"corecii","platform":"roblox","description":"A statically-generated API dump","version":"1.0.6540477","latest":"1.0.6540477","versions":["0.0.5240408","0.0.5250378","1.0.5250378","1.0.5260426","1.0.5270372","1.0.5280404","1.0.5290370","1.0.5300290","1.0.5310423","1.0.5320475","1.0.5330256","1.0.5340446","1.0.5350277","1.0.5360453","1.0.5360459","1.0.5380364","1.0.5390403","1.0.5390404","1.0.5400503","1.0.5410422","1.0.5410428","1.0.5420509","1.0.5420511","1.0.5430566","1.0.5440300","1.0.5450434","1.0.5460522","1.0.5460523","1.0.5470549","1.0.5480523","1.0.5490631","1.0.5490632","1.0.5500640","1.0.5510576","1.0.5510578","1.0.5520581","1.0.5520592","1.0.5520594","1.0.5530621","1.0.5540504","1.0.5540506","1.0.5550872","1.0.5550874","1.0.5570255","1.0.5580230","1.0.5590375","1.0.5600365","1.0.5610360","1.0.5620360","1.0.5630392","1.0.5640444","1.0.5650363","1.0.5660545","1.0.5670559","1.0.5670560","1.0.5670562","1.0.5680525","1.0.5680526","1.0.5690481","1.0.5690484","1.0.5700563","1.0.5710526","1.0.5720484","1.0.5730507","1.0.5740446","1.0.5750424","1.0.5760523","1.0.5770506","1.0.5780566","1.0.5800572","1.0.5810563","1.0.5820387","1.0.5831070","1.0.5831071","1.0.5831076","1.0.5860000","1.0.5870056","1.0.5880517","1.0.5890595","1.0.5890596","1.0.5900679","1.0.5900681","1.0.5910633","1.0.5920587","1.0.5930659","1.0.5940525","1.0.5950541","1.0.5960683","1.0.5960685","1.0.5970668","1.0.5980624","1.0.5990470","1.0.5990473","1.0.6000716","1.0.6010507","1.0.6020632","1.0.6030563","1.0.6030565","1.0.6040508","1.0.6050654","1.0.6050656","1.0.6050658","1.0.6050660","1.0.6070550","1.0.6080483","1.0.6080487","1.0.6090385","1.0.6090387","1.0.6100472","1.0.6110429","1.0.6110432","1.0.6120532","1.0.6130507","1.0.6130510","1.0.6140412","1.0.6140414","1.0.6150606","1.0.6150607","1.0.6160656","1.0.6160659","1.0.6170654","1.0.6180546","1.0.6180548","1.0.6190508","1.0.6200463","1.0.6210527","1.0.6220470","1.0.6230555","1.0.6240519","1.0.6240521","1.0.6250509","1.0.6260361","1.0.6260363","1.0.6270452","1.0.6270453","1.0.6280391","1.0.6290609","1.0.6300555","1.0.6300556","1.0.6310470","1.0.6310472","1.0.6320623","1.0.6330512","1.0.6340420","1.0.6350588","1.0.6360624","1.0.6360625","1.0.6360627","1.0.6370729","1.0.6380612","1.0.6380615","1.0.6390692","1.0.6400731","1.0.6400735","1.0.6410737","1.0.6430700","1.0.6440702","1.0.6450665","1.0.6450667","1.0.6450668","1.0.6460700","1.0.6470717","1.0.6480781","1.0.6490878","1.0.6500743","1.0.6510833","1.0.6510840","1.0.6530693","1.0.6540470","1.0.6540477"],"license":"MIT","licenseRating":"safe","licenseCaveats":["The package archive does not include its license text; the license is declared in its manifest metadata."],"licenseVerified":false,"dependencies":{},"integrity":"f00c57f28fc17bf03805b897792fd76ab2dd335a0110651b44e92930a2908623","likes":0,"downloads":0,"install":"forest install corecii/api-dump-static","url":"https://forest.dev/p/roblox/corecii/api-dump-static","files":"https://api.forest.dev/ai/package/roblox/corecii/api-dump-static/files","readme":"# API Dump (Static)\n\nA library that provides static Roblox API dumps.\n\nAPI dumps are updated when Roblox updates and you pull a new version of the package.\n\n[Documentation](https://corecii.github.io/api-dump-static/)\n\nInstall with [wally](https://wally.run):\n```toml\n# wally.toml\n[dependencies]\nApiDumpStatic = \"corecii/api-dump-static@^1.0\"\n```\n\n[or use a packaged release model](https://github.com/Corecii/api-dump-static/releases/latest)\n\nWhen using Wally, `wally install` will automatically grab the newest version by default.\nThis is because we only update the *patch* version for API dump changes, and by default\nwally grabs the newest version that isn't a breaking change.\n\n---\n\nThe primary advantages that this package provides over including the raw API dump in your project are:\n* the dump is pre-processed into multiple files so that it syncs in with Rojo correctly\n* the dump is automatically generated when Roblox updates\n* methods to get all members of a class are provided, where the raw API dump requires you to get the superclass members yourself\n\n---\n\nThis package allows you to inspect instances at runtime without having to download the API dump with HttpService.\n\nFor example:\n```lua\nlocal ApiDump = require(game.ReplicatedStorage.Packages.ApiDumpStatic)\n\nlocal thing = workspace.Baseplate\n\nlocal thingApi = ApiDump.Classes[thing.ClassName]\n\nfor name, info in pairs(thingApi:Properties()) do\n    if info.Security == \"None\" or info.Security.Read == \"None\" and not table.find(info.Tags or {}, \"NotScriptable\") then\n      print(\"Property\", name, \"of\", thing:GetFullName(),\"=\", thing[name])\n    end\nend\n```\n\nThe API is fairly light. It's just a wrapper around [Roblox-Client-Tracker/API-Dump.json](https://github.com/MaximumADHD/Roblox-Client-Tracker/blob/roblox/API-Dump.json) with nice methods for getting *all* members of a class (incl. of superclasses) and caching generated members lists. As such, it follows naming conventions of *Mini-API-Dump.json* for external access (i.e. UpperCamelCase / PascalCase for everything).\n\nThe raw API dump can be accessed using `ApiDump.Raw`. This is equivalent to loading [Roblox-Client-Tracker/API-Dump.json](https://github.com/MaximumADHD/Roblox-Client-Tracker/blob/roblox/API-Dump.json) directly.","readmeTruncated":false}