vls-redis

library3.14.0jsnpmunverified

VLS Redis is a Node.js library for interacting with Redis in VLS (Volans) systems. Current stable version is 3.14.0. Provides client classes for external code stations, internal code stations (using environment variables), and AWS Lambda environments. Written in TypeScript with emitted declarations. Differentiates by offering environment-specific Redis clients tailored to Volans architecture, with built-in configuration patterns for production, serverless, and local development. No significant release cadence documented.

database

npm install vls-redis

package ↗

INSTALL

IMPORT

SIG · VLS-REDIS

vls-redis

databasejavascriptv3.14.0

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.

ExternalCodeStationRedisClient

✓ import { ExternalCodeStationRedisClient } from 'vls-redis'

✗ const { ExternalCodeStationRedisClient } = require('vls-redis')

ESM import is the only supported pattern; CommonJS require will fail due to ESM-only module.

InternalCodeStationRedisClient

✓ import { InternalCodeStationRedisClient } from 'vls-redis'

This class reads Redis config from environment variables (REDIS_HOST, REDIS_PORT, REDIS_PASSWORD). No constructor options for host/port/password.

LambdaRedisClient

✓ import { LambdaRedisClient } from 'vls-redis'

✗ const LambdaRedisClient = require('vls-redis').LambdaRedisClient

For AWS Lambda; ESM only.

Creates an ExternalCodeStationRedisClient, sets a key, retrieves it, and logs the result. Demonstrates instantiation with explicit config and basic set/get operations.

import { ExternalCodeStationRedisClient } from 'vls-redis'; const redisClient = new ExternalCodeStationRedisClient({ host: process.env.REDIS_HOST ?? 'localhost', port: parseInt(process.env.REDIS_PORT ?? '6379', 10), codeStationName: process.env.CODE_STATION_NAME ?? 'default-station', companyName: process.env.COMPANY_NAME ?? 'default-company', }); async function main() { await redisClient.set('key', 'value'); const result = await redisClient.get('key'); console.log(result); // 'value' } main().catch(console.error);

Debug

Known issues

gotchaInternalCodeStationRedisClient requires REDIS_HOST, REDIS_PORT, and REDIS_PASSWORD environment variables to be set. Missing variables cause runtime errors.

fix

Ensure the environment variables are defined before creating an InternalCodeStationRedisClient instance.

affects: >=0.0.0

breakingVersion 3.x drops CommonJS support. require() will not work; only ESM imports are accepted.

fix

Use import { ... } from 'vls-redis' instead of require().

affects: >=3.0.0

gotchaThe library is primarily designed for Volans architecture; using it outside that context may require custom configuration.

fix

Review Volans documentation if using in a different system; consider using ioredis directly for custom setups.

affects: >=0.0.0

Errors

Common errors & fixes

Error: Cannot find module 'vls-redis'

Package not installed or incorrect import path.

fix

Run 'npm install vls-redis' and ensure import paths are correct.

TypeError: vls_redis_1.ExternalCodeStationRedisClient is not a constructor

Using CommonJS require with ESM-only module.

fix

Switch to ESM import: import { ExternalCodeStationRedisClient } from 'vls-redis'

Error: REDIS_HOST is not defined

InternalCodeStationRedisClient requires REDIS_HOST environment variable.

fix

Set REDIS_HOST, REDIS_PORT, and REDIS_PASSWORD environment variables or use ExternalCodeStationRedisClient.

Upgrade

Version history

3.14.0latest on npm

Audit

Dependencies

redisrequiredUnderlying Redis client library

Agent activity

22 hits · last 30 days

node