centrifugal-centrifugo

Namespace

centrifugal-centrifugo

Description:

  • Boost your app's real-time capabilities with Centrifugo, an open-source messaging server supporting WebSocket, HTTP-streaming, and more. Scale effortlessly, integrate with any backend, and enhance user engagement today!

Author:
Copyright:
  • 2026 Eyevinn Technology AB

Methods

(async, static) createCentrifugalCentrifugoInstance(context, body) → {CentrifugalCentrifugo}

Description:

  • Create a new Centrifugo instance

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

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

Open Source Cloud configuration context
body CentrifugalCentrifugoConfig

Service instance configuration
Returns:
  • Service instance
Type
CentrifugalCentrifugo

(async, static) getCentrifugalCentrifugoInstance(context, name) → {CentrifugalCentrifugo}

Description:

  • Get a Centrifugo instance

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

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

Open Source Cloud configuration context
name string

Name of the centrifugo to be retrieved
Returns:
  • Service instance
Type
CentrifugalCentrifugo

(async, static) removeCentrifugalCentrifugoInstance(context, name)

Description:

  • Remove a Centrifugo instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the centrifugo to be removed