@philiprehberger/ts-safe-json

Safe JSON parsing and serialization with circular detection and depth limiting.

Installation

npm install @philiprehberger/ts-safe-json

Usage

Safe Parse

import { safeParse } from '@philiprehberger/ts-safe-json';

const { ok, data, error } = safeParse<User>(jsonString);
if (ok) {
  console.log(data.name); // typed as User
} else {
  console.error(error.message);
}

Safe Stringify

import { safeStringify } from '@philiprehberger/ts-safe-json';

// Handles circular references
const obj: any = { name: 'test' };
obj.self = obj;
safeStringify(obj);
// {"name":"test","self":"[Circular]"}

// Depth limiting
safeStringify(deeplyNested, { maxDepth: 3 });
// Objects beyond depth 3 become "[MaxDepth]"

// Pretty print
safeStringify(data, { space: 2 });

API

| Export | Description | |--------|-------------| | safeParse<T>(input) | Parse JSON string, returns { ok, data?, error? } | | safeStringify(value, options?) | Stringify with circular/depth protection |

SafeParseResult<T>

| Property | Type | Description | |----------|------|-------------| | ok | boolean | Whether parsing succeeded | | data | T | Parsed value (if ok) | | error | Error | Parse error (if not ok) |

StringifyOptions

| Option | Type | Default | Description | |--------|------|---------|-------------| | maxDepth | number | — | Max nesting depth before "[MaxDepth]" | | replacer | (key, value) => unknown | — | Custom replacer function | | space | number | — | Indentation spaces |

Development

npm install
npm run build
npm test

License

MIT