ether-etherpad-lite

Namespace

ether-etherpad-lite

Description:

  • Unleash seamless collaboration with Etherpad, the ultimate real-time web editor! Host unlimited users on your servers, secure data control, and customize with essential plugins. Elevate teamwork today!

Author:
Copyright:
  • 2026 Eyevinn Technology AB

Methods

(async, static) createEtherEtherpadLiteInstance(context, body) → {EtherEtherpadLite}

Description:

  • Create a new Etherpad Lite instance

Example
import { Context } from '@osaas/client-core';
import { createEtherEtherpadLiteInstance } from '@osaas/client-services';

const ctx = new Context();
const body: EtherEtherpadLiteConfig = { name: 'myinstance', ... };
const instance = await createEtherEtherpadLiteInstance(ctx, body);
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
body EtherEtherpadLiteConfig

Service instance configuration
Returns:
  • Service instance
Type
EtherEtherpadLite

(async, static) getEtherEtherpadLiteInstance(context, name) → {EtherEtherpadLite}

Description:

  • Get a Etherpad Lite instance

Example
import { Context } from '@osaas/client-core';
import { getEtherEtherpadLiteInstance } from '@osaas/client-services';

const ctx = new Context();
const instance = await getEtherEtherpadLiteInstance(ctx, 'myinstance');
console.log(instance.url);
Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the etherpad to be retrieved
Returns:
  • Service instance
Type
EtherEtherpadLite

(async, static) removeEtherEtherpadLiteInstance(context, name)

Description:

  • Remove a Etherpad Lite instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the etherpad to be removed