isaacscript-common
Version:
Helper functions and features for IsaacScript mods.
24 lines • 1.08 kB
TypeScript
/**
* 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.
*/
export declare function jsonDecode(jsonString: string): LuaMap<AnyNotNil, unknown> | undefined;
/**
* 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.
*/
export declare function jsonEncode(luaTable: unknown): string;
//# sourceMappingURL=jsonHelpers.d.ts.map