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

y-pojo

v0.0.8

Published

Syncronize a YJS document to/from a plain old javascript object

Downloads

14

Readme

y-pojo

Syncronize a YJS document to/from a plain old javascript object

This library enables multiple users to share state in the form of a Plain ol' Javascript object (POJO), by mapping changes on the POJO into a Y.Map, and mapping Y.Map changes back into a new copy of the POJO (via yMap.toJSON).

It supports regular, simple, javascript objects (called a Record in Typescript). It supports objects, arrays, and other simple types that can be JSON marshalled.

It contains two methods, syncronize and deepEquals. Call syncronize(yMap, pojo) to compare the current state of a YJS map to the state of the POJO, and apply the required changes to the YJS map to make it equal to the same value as the pojo. It assumes your network layer is registered with the YJS document to capture and communicate these updates to the other users.

When a remote user has updated the YJS document, simple call yMap.toJSON() to get the new copy of the POJO on the other clients.

Example

import {syncronize} from "y-pojo"
import * as Y from 'yjs'

let doc1 = new Y.Doc()
let root = doc1.getMap("r")
let targetObject = {
   name: "Tom",
   count: 42,
   pets: [{"name": "Jerry"}, {"name": "Bob"}]
}
syncronize(root, targetObject)
console.log(JSON.stringify(root.toJSON())) // {"name":"Tom","count":42,"pets":[{"name":"Jerry"},{"name":"Bob"}]}

let updatedTargetObject = {
   name: "Tom",
   count: 42,
   pets: [{"name": "Jerry"}, {"name": "Bob"},  {"name": "Carol"}]
}

syncronize(root, updatedTargetObject)
console.log(JSON.stringify(root.toJSON())) // {"name":"Tom","count":42,"pets":[{"name":"Jerry"},{"name":"Bob"},{"name":"Carol"}]}

Limitations

  • It won't work with Regex, or Date, or other classes.
  • strings within the javascript object are not represented as Y.Text and deep compared - they are static strings that get replaced when edited. So it would be better to use Y.Text directly for text document editing.