Serialization

Export diff results for humans, logs, or downstream tools.

Previous: Patching · Back to: Overview

Playground

Open JSON viewer → — inspect serialized output formats.

Problem → approach

Typical pain	serialize()
console.log(diffResult) is noisy and not PR-ready	serialize(result, "markdown") for changelogs and review comments
APIs need structured payloads; humans need tables	Same diff() output, multiple export formats
Custom formatters duplicated across tools	One serializer with json, markdown, and table targets

JSON export

import { diff, serialize } from "@jayoncode/object-diff";

const result = diff(before, after);
const json = serialize(result, "json");

Markdown for changelogs

const markdown = serialize(result, "markdown");
// paste into PR body or release notes

Table format

const table = serialize(result, "table");
// compact tabular view for terminals or docs

When to use each format

Format	Best for
json	APIs, structured logs
markdown	PRs, docs, changelogs
table	CLI output, quick scans

Done with the guides? Browse the API Reference or playground examples.