JSON
Functions
Section titled “Functions”jsonDecode()
Section titled “jsonDecode()”jsonDecode(
jsonString):LuaMap<AnyNotNil,unknown> |undefined
Defined in: packages/isaacscript-common/src/functions/jsonHelpers.ts:15
Converts a JSON string to a Lua table.
In most cases, this function will be used for reading data from a “save#.dat” file. If decoding fails, it will return undefined instead of throwing an error. (This allows execution to continue in cases where users have no current save data or have manually removed their existing save data.)
Under the hood, this uses a custom JSON parser that was measured to be 11.8 times faster than the vanilla JSON parser.
Parameters
Section titled “Parameters”jsonString
Section titled “jsonString”string
Returns
Section titled “Returns”LuaMap<AnyNotNil, unknown> | undefined
jsonEncode()
Section titled “jsonEncode()”jsonEncode(
luaTable):string
Defined in: packages/isaacscript-common/src/functions/jsonHelpers.ts:38
Converts a Lua table to a JSON string.
In most cases, this function will be used for writing data to a “save#.dat” file. If encoding fails, it will throw an error to prevent writing a blank string or corrupted data to a user’s “save#.dat” file.
Under the hood, this uses a custom JSON parser that was measured to be 11.8 times faster than the vanilla JSON parser.
Parameters
Section titled “Parameters”luaTable
Section titled “luaTable”unknown
Returns
Section titled “Returns”string