isaac-typescript-definitions/src/types/json.d.ts

TypeScript definitions for The Binding of Isaac: Repentance.

/**
 * The "json.lua" module exists at:
 *
 * ```text
 * C:\Program Files (x86)\Steam\steamapps\common\The Binding of Isaac Rebirth\resources\scripts\json.lua
 * ```
 *
 * IsaacScript mods should avoid consuming it directly and instead use the `jsonEncode` and
 * `jsonDecode` helper functions.
 *
 * (These helper functions use a custom JSON parser that was benchmarked to be 11.8 times faster
 * than the vanilla parser.)
 *
 * @module
 */

/**
 * We need to specify the "@noResolution" TSTL compiler annotation here because the "json.lua" file
 * is not supposed to exist inside of end-user mods.
 *
 * @noResolution
 * @noSelf
 */
declare module "json" {
  function encode(data: unknown): string;
  function decode(data: string): unknown;
}