Skip to content

docs: clarify parsing fenced model output #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rupayon123 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: clarify parsing fenced model output #22

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
969704f
docs: clarify parsing fenced model output
rupayon123 Jun 23, 2026
4ea5649
docs: handle prose around fenced JSON
rupayon123 Jun 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,18 @@ result = parse("-Inf");
console.log(result); // Outputs: -Infinity
```

### Parsing model replies with Markdown fences

`parse` expects the JSON text itself. If a model wraps JSON in Markdown fences or surrounding prose, strip that wrapper before passing the string to `parse`:

````js
const reply = "Here is the JSON:\n```json\n{\"status\": \"ok\"}\n```";
const match = reply.match(/```(?:json)?\s*([\s\S]*?)\s*```/i);
const json = match ? match[1] : reply;

parse(json); // Outputs: { status: "ok" }
````

### Handling malformed JSON

If the JSON string is malformed, the `parse` function will throw an error:
Expand Down