{"id":46764,"library":"vls-redis","title":"vls-redis","description":"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.","status":"active","version":"3.14.0","language":"javascript","source_language":"en","source_url":null,"tags":["javascript","typescript"],"install":[{"cmd":"npm install vls-redis","lang":"bash","label":"npm"},{"cmd":"yarn add vls-redis","lang":"bash","label":"yarn"},{"cmd":"pnpm add vls-redis","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Underlying Redis client library","package":"redis","optional":false}],"imports":[{"note":"ESM import is the only supported pattern; CommonJS require will fail due to ESM-only module.","wrong":"const { ExternalCodeStationRedisClient } = require('vls-redis')","symbol":"ExternalCodeStationRedisClient","correct":"import { ExternalCodeStationRedisClient } from 'vls-redis'"},{"note":"This class reads Redis config from environment variables (REDIS_HOST, REDIS_PORT, REDIS_PASSWORD). No constructor options for host/port/password.","symbol":"InternalCodeStationRedisClient","correct":"import { InternalCodeStationRedisClient } from 'vls-redis'"},{"note":"For AWS Lambda; ESM only.","wrong":"const LambdaRedisClient = require('vls-redis').LambdaRedisClient","symbol":"LambdaRedisClient","correct":"import { LambdaRedisClient } from 'vls-redis'"}],"quickstart":{"code":"import { ExternalCodeStationRedisClient } from 'vls-redis';\n\nconst redisClient = new ExternalCodeStationRedisClient({\n  host: process.env.REDIS_HOST ?? 'localhost',\n  port: parseInt(process.env.REDIS_PORT ?? '6379', 10),\n  codeStationName: process.env.CODE_STATION_NAME ?? 'default-station',\n  companyName: process.env.COMPANY_NAME ?? 'default-company',\n});\n\nasync function main() {\n  await redisClient.set('key', 'value');\n  const result = await redisClient.get('key');\n  console.log(result); // 'value'\n}\n\nmain().catch(console.error);","lang":"typescript","description":"Creates an ExternalCodeStationRedisClient, sets a key, retrieves it, and logs the result. Demonstrates instantiation with explicit config and basic set/get operations."},"warnings":[{"fix":"Ensure the environment variables are defined before creating an InternalCodeStationRedisClient instance.","message":"InternalCodeStationRedisClient requires REDIS_HOST, REDIS_PORT, and REDIS_PASSWORD environment variables to be set. Missing variables cause runtime errors.","severity":"gotcha","affected_versions":">=0.0.0"},{"fix":"Use import { ... } from 'vls-redis' instead of require().","message":"Version 3.x drops CommonJS support. require() will not work; only ESM imports are accepted.","severity":"breaking","affected_versions":">=3.0.0"},{"fix":"Review Volans documentation if using in a different system; consider using ioredis directly for custom setups.","message":"The library is primarily designed for Volans architecture; using it outside that context may require custom configuration.","severity":"gotcha","affected_versions":">=0.0.0"}],"env_vars":null,"search_vec":"'3.14.0':22 'architectur':57 'aw':37 'built':60 'built-in':59 'cadenc':73 'class':25 'client':24,53 'code':28,31 'configur':62 'current':18 'declar':45 'develop':69 'differenti':46 'document':74 'emit':44 'environ':34,39,50 'environment-specif':49 'extern':27 'interact':11 'intern':30 'javascript':75 'lambda':38 'librari':9 'local':68 'node.js':8 'offer':48 'pattern':63 'product':65 'provid':23 'redi':3,5,13,52 'releas':72 'serverless':66 'signific':71 'specif':51 'stabl':19 'station':29,32 'system':17 'tailor':54 'typescript':42,76 'use':33 'variabl':35 'version':20 'vls':2,4,15 'vls-redi':1 'volan':16,56 'written':40","created_at":"2026-06-07T13:01:31.539736+00:00","updated_at":"2026-06-07T13:01:31.539736+00:00","problems":[{"fix":"Run 'npm install vls-redis' and ensure import paths are correct.","cause":"Package not installed or incorrect import path.","error":"Error: Cannot find module 'vls-redis'"},{"fix":"Switch to ESM import: import { ExternalCodeStationRedisClient } from 'vls-redis'","cause":"Using CommonJS require with ESM-only module.","error":"TypeError: vls_redis_1.ExternalCodeStationRedisClient is not a constructor"},{"fix":"Set REDIS_HOST, REDIS_PORT, and REDIS_PASSWORD environment variables or use ExternalCodeStationRedisClient.","cause":"InternalCodeStationRedisClient requires REDIS_HOST environment variable.","error":"Error: REDIS_HOST is not defined"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":null,"github":null,"docs":null,"changelog":null,"pypi":null,"npm":"vls-redis","openapi_spec":null,"status_page":null,"smithery":null,"categories":["database"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-07","next_check":"2026-09-05","install_tag":null}}