omega-edit

library0.9.58jsnpmunverified

OmegaEdit is an open-source library for building editors that can handle massive files and multiple viewports. The TypeScript client package (v0.9.58) provides gRPC client types and interfaces for interacting with the OmegaEdit server, generated from protobuf definitions. It supports Node.js and browser environments, with ESM and CJS builds. Key differentiators: designed for extremely large file editing with minimal memory overhead, uses a client-server architecture via gRPC, and provides type-safe TypeScript bindings. Alternates include Monaco Editor or CodeMirror but lack the large-file focus. Release cadence is irregular; latest stable version is 0.9.58.

devops storage

npm install omega-edit

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · OMEGA-EDIT

omega-edit

devopsjavascriptv0.9.58

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Session

✓ import { Session } from 'omega-edit'

✗ const Session = require('omega-edit').Session

Package is ESM-first; default export not available.

createSession

✓ import { createSession } from 'omega-edit'

✗ import createSession from 'omega-edit'

createSession is a named export, not a default export.

OmegaEditClient

✓ import { OmegaEditClient } from 'omega-edit'

✗ import { Client } from 'omega-edit'

The gRPC client class is named OmegaEditClient, not Client.

Creates a gRPC client, establishes a session with a file, and prints the session ID.

import { createSession, OmegaEditClient } from 'omega-edit'; import { credentials } from '@grpc/grpc-js'; const client = new OmegaEditClient('localhost:50051', credentials.createInsecure()); const session = await createSession(client, { filePath: '/path/to/file.txt' }); console.log('Session ID:', session.sessionId); client.close();

Debug

Known issues

gotchaVersion 0.9.x uses gRPC web for browser contexts; Node.js requires @grpc/grpc-js. Mixing transports causes runtime errors.

fix

Ensure you install the correct gRPC transport package: for Node.js use @grpc/grpc-js, for browser use @improbable-eng/grpc-web.

affects: >=0.9.0

gotchaThe Session object is not directly serializable; cloning via JSON.stringify/parse loses gRPC metadata.

fix

Use the provided serialization methods if needed, or keep the session reference alive.

affects: >=0.9.0

deprecatedcreateSession with filePath parameter is deprecated; use createSession with a File object instead.

fix

Pass a File object with path property: createSession(client, { file: { path: '/path/to/file.txt' } }).

affects: >=0.9.50

Errors

Common errors & fixes

Error: 12 UNIMPLEMENTED: method not found

gRPC method not implemented on the server side or wrong service definition.

fix

Ensure the OmegaEdit server is the correct version and running the compiled proto definitions that match this client version.

TypeError: Cannot read properties of undefined (reading 'path')

File object not properly constructed; path property is missing.

fix

Use the correct createSession signature: createSession(client, { file: { path: '/path/to/file.txt' } }).

Module not found: Error: Can't resolve 'omega-edit'

Package not installed or not in node_modules.

fix

Run npm install omega-edit@0.9.58. Ensure the package is in your dependencies.

Upgrade

Version history

0.9.58latest on npm

Audit

Dependencies

@grpc/grpc-jsrequiredgRPC client runtime required for communication with OmegaEdit server

google-protobufrequiredProtobuf runtime for serialization/deserialization

Agent activity

33 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

githubhttps://github.com/ctc-oss/omega-edit ↗

packageomega-edit ↗

homepagehttps://github.com/ctc-oss/omega-edit ↗