Overview

Solidis is a high-performance, SOLID-structured RESP client crafted for connecting to Redis and other RESP-compatible servers. Built with enterprise-grade performance and minimal dependencies in mind, it supports both RESP2 and RESP3 protocols, making it suitable for modern JavaScript and TypeScript applications. The design prioritizes a minimal bundle size while ensuring maximum type safety and performance.

Key Features

• High Performance: Optimized for efficiency with a minimal memory footprint, intelligent buffer management, and zero-copy buffer operations.
• Protocol Support: Seamlessly negotiates between RESP2 and RESP3, ensuring binary-safe operations and full multi-byte character support.
• Advanced Functionality: Supports transactions, pipeline operations, and Pub/Sub functionality, along with automatic reconnection and command timeout handling.
• Type Safety: Offers comprehensive TypeScript definitions and robust runtime reply type checking, enhancing developer experience and application reliability.
• Extensibility: Easily extend the client with custom commands and support for plugin architecture.
• Lightweight: Achieves a minimal bundle size of less than 30KB with zero runtime dependencies.

Requirements

• Runtime: Node.js 14 or higher
• Development: Node.js 22 LTS recommended for optimal stability

Usage Examples

Basic Client (SolidisClient)

import { SolidisClient } from '@vcms-io/solidis';
import { get } from '@vcms-io/solidis/command/get';
import { set } from '@vcms-io/solidis/command/set';

const client = new SolidisClient({ host: '127.0.0.1', port: 6379 }).extend({ get, set });
await client.set('key', 'value');
const value = await client.get('key');

Featured Client (SolidisFeaturedClient)

import { SolidisFeaturedClient } from '@vcms-io/solidis/featured';

const client = new SolidisFeaturedClient({ host: '127.0.0.1', port: 6379 });
await client.set('key', 'value');

Transaction Example

const transaction = client.multi();
transaction.set('key', 'value');
const results = await transaction.exec();

Error Handling

Solidis provides detailed error handling capabilities, allowing for easy diagnosis and resolution. Use the appropriate error classes for tailored responses based on the type of error encountered.

try {
    await client.set('key', 'value');
} catch (error) {
    if (error instanceof SolidisConnectionError) {
        // handle connection error
    }
}

Contribution

Solidis welcomes contributions from the community. To get started, clone the repository, set up your development environment, and follow the contribution guidelines outlined.

Solidis is designed for developers who need a reliable and efficient RESP client without the overhead of unnecessary dependencies. It empowers applications to leverage the full capabilities of Redis and enhance performance seamlessly.