https://github.com/k-l-lambda/web-editor

WebSocket based text file synchronizer.
https://github.com/k-l-lambda/web-editor

Last synced: 4 months ago
JSON representation

WebSocket based text file synchronizer.

• Host: GitHub
• URL: https://github.com/k-l-lambda/web-editor
• Owner: k-l-lambda
• Created: 2020-08-25T02:48:40.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2025-10-30T09:54:02.000Z (8 months ago)
• Last Synced: 2025-10-30T11:44:22.349Z (8 months ago)
• Language: TypeScript
• Size: 33.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          

#	web-editor ![logo](./app/favicon.ico)

A WebSocket based text file synchronizer between disk and web browser.

## Installation

```bash

npm install @k-l-lambda/web-editor --save

```

## Usage

* Backend example:

```javascript

import http from "http";

import * as webEditor from "@k-l-lambda/web-editor";

// setup a web socket server over HTTP

const httpServer = http.createServer();

httpServer.listen("8080", "127.0.0.1", () => {

	console.log("WebEditor server is online.");

});

webEditor.service.createServer(httpServer, {rootDir: "/my-assets-folder"});

```

* Frontend example:

```javascript

import * as webEditor from "@k-l-lambda/web-editor";

// assume you have a textarea with id 'my-textarea' in DOM

const $textarea = document.querySelector("#my-textarea");

const remoteFile = new webEditor.RemoteFile();

remoteFile.on("sync", ({timestamp}) => {

	// receive change from disk

	$textarea.value = remoteFile.content;

	console.log("Disk change synchronized:", new Date(timestamp));

});

$textarea.onchange = () => {

	// send browser modification to disk

	remoteFile.content = $textarea.value;

};

// assume you have a file '/my-assets-folder/my-text.txt' on disk

remoteFile.connect("ws://127.0.0.1:8080", "my-text.txt");

```