JSPM

  • Created
  • Published
  • Downloads 349606
  • Score
    100M100P100Q220853F
  • License MIT

Mendoza, differ for structured documents

Package Exports

  • mendoza

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (mendoza) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

mendoza-js

npm versionBuild Statusnpm bundle size

Mendoza decoder in TypeScript.

Installation

$ npm install mendoza
// or
$ yarn add mendoza

Usage

Basic example:

import {applyPatch} from "mendoza"

let left = {};
let patch = [];
let right = applyPatch(left, patch);

Incremental patcher:

import {incremental} from "mendoza"

const {Value, rebaseValue, wrap, unwrap, getType, applyPatch} = incremental

// Create an empty initial version:
const ROOT = wrap(null, null);

// Input of patches:
let patches = [];

// `origin` can be whatever you want to identify where a change comes from:
let origin = 0;

// Reference to the latest version:
let value = ROOT;

// Rebasing is for maintaing history across deleted versions:
let rebaseTarget;

for (let patch of patches) {
  // Apply the patch:
  let newValue = applyPatch(value, patch, origin);

  // Rebase if needed:
  if (rebaseTarget) {
    newValue = rebaseValue(rebaseTarget, newValue);
  }

  // If the document was deleted, store the previous version so we can rebase:
  if (getType(newValue) === "null") {
    rebaseTarget = value;
  } else {
    rebaseTarget = null;
  }

  value = newValue;
  origin++;
}

// Return the final full object:
console.log(unwrap(value));

License

MIT © Sanity.io