effect-io-ai

Package: effect
Module: SchemaGetter

SchemaGetter.parseJson

Parses a JSON string into a value.

When to use

Use when you need a schema getter to parse a present encoded JSON string during decoding.

Details

• Skips None inputs.
• Without reviver: returns Schema.MutableJson (typed JSON).
• With reviver: returns unknown (reviver may produce arbitrary values).
• On parse failure, fails with SchemaIssue.InvalidValue containing the error message.

Example (Parsing JSON)

import { SchemaGetter } from "effect"

const parse = SchemaGetter.parseJson<string>()
// Getter<MutableJson, string>

See

• stringifyJson for the inverse operation

Signature

declare const parseJson: { <E extends string>(): Getter<Schema.MutableJson, E>; <E extends string>(options: ParseJsonOptions): Getter<unknown, E>; }

Source

Since v4.0.0