valkey-io-valkey

Namespace

valkey-io-valkey

Description:

  • Introducing Valkey: a Redis-compatible high-performance key-value store with wide range support. Build on various systems, extensible plugin system, and TLS support available.

    NB! Data persistence not guaranteed

Author:
Copyright:
  • 2025 Eyevinn Technology AB
See:

Methods

(async, static) createValkeyIoValkeyInstance(context, body) → {ValkeyIoValkey}

Description:

  • Create a new valkey instance

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

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

Open Source Cloud configuration context
body ValkeyIoValkeyConfig

Service instance configuration
Returns:
  • Service instance
Type
ValkeyIoValkey

(async, static) getValkeyIoValkeyInstance(context, name) → {ValkeyIoValkey}

Description:

  • Get a valkey instance

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

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

Open Source Cloud configuration context
name string

Name of the valkey to be retrieved
Returns:
  • Service instance
Type
ValkeyIoValkey

(async, static) removeValkeyIoValkeyInstance(context, name)

Description:

  • Remove a valkey instance

Parameters:
Name Type Description
context Context

Open Source Cloud configuration context
name string

Name of the valkey to be removed