Skip to content
This repository has been archived by the owner on Aug 15, 2024. It is now read-only.

Commit

Permalink
v0.1.1 (#6)
Browse files Browse the repository at this point in the history
- Export `Types` from `Dump`
- Update docs for `fetchRawDump` and `fetchFromServer`
  • Loading branch information
cxmeel authored Dec 3, 2022
1 parent 1be043f commit 723b734
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
15 changes: 12 additions & 3 deletions src/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,15 @@ local ERR_UNKNOWN_CLASSNAME = "Could not find class in dump with name %q"
]=]
Dump.Filter = table.freeze(Filter)

--[=[
@prop Types {}
@within Dump
A reference to the `Types` module, which contains various
types used within the API dump parser.
]=]
Dump.Types = T

--[=[
@function new
@within Dump
Expand Down Expand Up @@ -68,7 +77,7 @@ end
@param hashOrVersion string?
@return APIDump
Fetches the API dump for the current version of Roblox from the
Fetches the raw API dump for the current version of Roblox from the
Roblox API. If a hash or version is provided, it will attempt to
fetch the dump for that hash or version.
]=]
Expand All @@ -88,8 +97,8 @@ end
@param hashOrVersion string?
@return Dump
Performs the same actions as [`fetchDump`][Dump.fetchDump], but returns a
[Dump] instance instead of the raw API data.
Performs the same actions as [`fetchRawDump`][Dump.fetchRawDump], but
returns a [Dump] instance instead of the raw API data.
]=]
function Dump.fetchFromServer(hashOrVersion: string?)
local apiDump = Dump.fetchRawDump(hashOrVersion)
Expand Down
2 changes: 1 addition & 1 deletion wally.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "csqrl/dump-parser"
version = "0.1.0"
version = "0.1.1"
registry = "https://github.com/UpliftGames/wally-index"
realm = "shared"

Expand Down

0 comments on commit 723b734

Please sign in to comment.