Function json

The json function is a parsing utility to get a typed and runtime-validated object out of a JSON string. It exists in two versions: one that returns a Result and one that throws an error if the validation fails.

Safe version

Example

import { json } from "typerun";
import { object, string } from "typerun/schema";
import { isOk } from "typerun/result";

const schema = object({ name: string });
const result = json(schema)(`{"name": "Alice"}`);
if (isOk(result)) {
  console.log(result.data.name); // "Alice"
}
Copy

Throwing version

Example

import { json } from "typerun";
import { object, string } from "typerun/schema";
import { isOk } from "typerun/result";

const schema = object({ name: string });
try {
  const result = json(schema, { throwing: true })(`{"name": "Alice"}`);
  console.log(result.name); // "Alice"
} catch (errors) {
  console.error(errors);
}
Copy