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

woot-js

v0.0.9

Published

Core library for creating real time collaborative documents without Operational transformation (WOOT). This package provides the core logic and data types for building a server capable and handling real time editing with WOOT.

Downloads

17

Readme

woot-js

Core library for creating real time collaborative documents without operational transformation (WOOT). This package provides the core logic and data types for building a client and server capable of handling real time editing with WOOT. This package is environment agnostic - meaning it is suitable for use in both client and server environments.

Note: if building a real time collaborative application, you will also need a notification layer (such as web-sockets), and likely a library to help handle input events (such as a JS text editor).

References:

Setup

Install

$ npm install --save woot-js

Test

npm test

Examples

For a detailed example, take a look at the example directory. This shows a minimal setup using woot-js along with a web socket library to create a real time collaborative application with multiple clients.

Start the server using node example/server.js. Then navigate to http://localhost:3000/example to see the running application. Open multiple browser windows to see realtime updates across multiple clients.

Note: this is a minimal example used to show how operations can be managed across multiple clients. It does not correctly handle all text editing interactions, such as copy/paste/bulk delete - a more robust application would likely use a JS text editor to better handle these events.

Documentation

  • makeWootClientEmpty :: Int -> WootClient

Takes a client id and returns a new client with an empty string. This will most often be used on the server when initializing a new client.

  • makeWootClient :: WString -> Int -> WootClient

Creates a client from a known string. This will most often be used to sync a newly connected client with existing server state.

  • sendOperation :: WootClient -> Operation -> WootClient

Apply an operation to a client. Note: if the operation cannot be applied the original client will be returned without modification.

  • sendLocalDelete :: WootClient -> Int -> {operation: ?Operation, client: WootClient}
  • sendLocalInsert :: WootClient -> Int -> String -> {operation: ?Operation, client: WootClient}

Apply a local operation to a client. This should only be used when directly applying a local modification to the client that originated it. If the resulting value includes a non-null operation, the operation should be emitting to all other connected clients. Note: this makes assumptions about the ability to integrate to provided operation into the client.

  • showClientString :: WootClient -> String

Format a string representation of the internal client string.

TODO

  • Setup CI