ThetaDev/automerge
1
0
Fork 0
Code Issues Pull requests Projects Releases Activity
automerge/automerge-js
History
Orion Henry de1dab748d
move automerge-js onto the applyPatches model
2022-10-02 19:04:26 +01:00
..
config some api changes/tweaks - basic js package 2022-05-31 13:49:18 -04:00
e2e Add an e2e testing tool for the JS packaging 2022-10-02 19:01:06 +01:00
examples Add examples of using automerge with bundlers 2022-10-02 19:01:06 +01:00
src move automerge-js onto the applyPatches model 2022-10-02 19:04:26 +01:00
test move automerge-js onto the applyPatches model 2022-10-02 19:04:26 +01:00
.eslintignore tslint to eslint 2022-05-22 13:53:11 -04:00
.eslintrc.cjs tslint to eslint 2022-05-22 13:53:11 -04:00
.gitignore fix some typescript errors - depricate default export of the wasm package 2022-08-11 18:24:21 -05:00
index.d.ts move automerge-js onto the applyPatches model 2022-10-02 19:04:26 +01:00
LICENSE able to build npm package 2022-05-22 13:53:11 -04:00
package.json move automerge-js onto the applyPatches model 2022-10-02 19:04:26 +01:00
README.md Fixup js edit-trace script and documentation bits 2022-07-07 09:25:45 +01:00
tsconfig.json clean up lint, simplify package, hand write an index.d.ts 2022-05-23 19:04:31 +02:00
tslint.json convert automerge-js to typescript 2022-05-22 13:53:11 -04:00

README.md

Automerge JS

This is a reimplementation of Automerge as a JavaScript wrapper around the "automerge-wasm".

This package is in alpha and feedback in welcome.

The primary differences between using this package and "automerge" are as follows:

  1. The low level api needs to plugged in via the use function. The only current implementation of "automerge-wasm" but another could used in theory.
import * as Automerge from "automerge-js";
import * as wasm_api from "automerge-wasm";

// browsers require an async wasm load - see automerge-wasm docs
Automerge.use(wasm_api);

  1. There is no front-end back-end split, and no patch format or patch observer. These concepts don't make sense with the wasm implementation.

  2. The basic Doc<T> object is now a Proxy object and will behave differently in a repl environment.

  3. The 'Text' class is currently very slow and needs to be re-worked.

Beyond this please refer to the Automerge README for further information.