npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

automerge-clocks

v1.2.1

Published

This library contains a set of utilities for implementing your own Automerge network protocol.

Downloads

18

Readme

Automerge Clocks

This library contains a set of utilities for implementing your own Automerge network protocol.

Install

npm install --save automerge-clocks

Usage

An Automerge network protocol should keep track of the Vector Clock of it's local document as well as the clock (or clocks) of it's peers. A Vector Clock is an immutable map of Actors (someone who did something to the document) and a counter of changes they've made to the document (called the sequence).

For example, a clock might look like this:

import { Map } from "immutable";

const clock = Map({
  "georges-uuid": 5,
  "alices-uuid": 10
});

If all seq counters for all actors in a clock are less than or equal to those another clock, we'll say the first clock is "earlier" than the second.

The TL;DR of your protocol

Keep a copy of our clock and their clock. Then, follow these rules:

  • If theirClock is "earlier" than ourClock, then send changes.
  • If ourClock is "earlier" than theirClock, then ask for changes.

The building blocks

getClock

All Automerge documents have a clock. automerge-clocks has a built-in helper to get the current clock:

import { getClock } from "automerge-clocks";
import { init } from "automerge";

const myDoc = init();
const clock = getClock(myDoc); // hurray it's a clock!

later

To check if one clock is earlier than another, use later:

import { later } from "automerge-clocks";

const shouldSendChanges = later(ourClock, theirClock);

recentChanges

Given theirClock and our current document, get the changes we'd need to send in order to update the peer to where we are.

import { recentChanges } from "automerge-clocks";

const changes = recentChanges(ourDoc, theirClock);
MyNetwork.send(changes);

If ourDoc is earlier than theirClock, recentChanges will return [].

const changes = recentChanges(superOldDoc, superNewClock);
changes == []; // Nothing to update!

union

To combine clocks, use union:

import { union } from "automerge-clocks";

union(ourClock, theirClock);

You should use this after you make a change and send it to a peer. For example:

import { union, recentChanges, getClock } from "automerge-clocks";

// Make changes and send them to the network
const newDoc = Automerge.change(ourDoc, d => {
  d.name = "new-name";
});
const changes = recentChanges(newDoc, theirClock);
MyNetwork.send(changes);

// use `union` to optimisticly update theirClock
// with what we just sent them
theirClock = union(theirClock, getClock(newDoc));

License

MIT