@sanity/diff
Advanced tools
@sanity/diff is a library for calculating and presenting diffs of content.
The main data structure is Diff which represents a difference between two versions. This is a
nested data structure so if it's an ObjectDiff, then its children will have Diff as well.
The Diff is built on top of the unchanged, added and removed primitives. This means that
it will contain both versions at the same time and it's always trivial to recreate the old/new
version (by ignoring the added/removed parts of the diff).
Note that for arrays and objects, unchanged/added/removed only have a "shallow" meaning. An
ObjectDiff will have a unchanged field if the field was present in both the old and new
version - regardless of whether there's any internal changes.
Diff also supports annotations. These contain information about when a change was introduced
and who was responsible for it.
To construct a Diff you need to represent the versions as Input types and use diffInput(from,to)
to create the diff. The primary reason for a separate Input type is to support passing along
annotations. In addition, this allows us to optimize based on the object equality of the inputs.
There are multiple ways of presenting a diff: Sometimes you want to only show the fields that has changed, and other times you want to show the full new (or old!) document interspersed with the changes.
This library does not contain any UI components, but instead provides various presentation-related helper functions.
FAQs
Generates diffs between documents and primitive types
The npm package @sanity/diff receives a total of 159,349 weekly downloads. As such, @sanity/diff popularity was classified as popular.
We found that @sanity/diff demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 90 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ECMAScript 2025 introduces Iterator Helpers, Set methods, JSON modules, and more in its latest spec update approved by Ecma in June 2025.
Security News
A new Node.js homepage button linking to paid support for EOL versions has sparked a heated discussion among contributors and the wider community.
Research
North Korean threat actors linked to the Contagious Interview campaign return with 35 new malicious npm packages using a stealthy multi-stage malware loader.
