Json

const Json: object

Defined in: Data/Json.ts:23

Pure, non-throwing JSON utilities. Wraps runtime JSON parsing and stringifying in typed Result containers.

Type Declaration

parse

parse: <T>(text) => Result<SyntaxError, T>

Safely parses a JSON string into unknown (or a designated type T). Converts thrown exceptions into a Result<SyntaxError, T>.

Type Parameters

T

T = unknown

Parameters

text

string

Returns

Result<SyntaxError, T>

Example

Json.parse('{"a": 1}'); // Ok({ a: 1 })
Json.parse('{invalid}'); // Err(SyntaxError)

stringify

stringify: (value, replacer?, space?) => Result<TypeError, string>

Safely stringifies a value into a JSON string. Converts thrown exceptions (e.g. circular references) or un-serializable values (e.g. undefined, functions) into a Result<TypeError, string>.

Parameters

value

unknown

replacer?

(this, key, value) => any

space?

string | number

Returns

Result<TypeError, string>

Example

Json.stringify({ a: 1 }); // Ok('{"a":1}')
Json.stringify(undefined); // Err(TypeError)

Example

import { Json, pipe } from "@pplnd/core";

const result = pipe(
  Json.parse<{ readonly name: string }>('{"name":"Alice"}'),
  Result.map((data) => data.name)
); // Ok("Alice")