@litert/redis/src/lib/ModuleAPI.ts

A redis protocol implement for Node.js.

/**
 * Copyright 2025 Angus.Fenying <fenying@litert.org>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { Decoder } from './Decoder';
import { Encoder } from './Encoder';
import { ProtocolClient } from './ProtocolClient';
import { CommandClient } from './CommandClient';
import { SubscriberClient } from './Subscriber';
import * as C from './Common';
import * as Constants from './Constants';

export function createDecoder(): C.IDecoder {

    return new Decoder();
}

export function createEncoder(): C.IEncoder {

    return new Encoder();
}

/**
 * Create a standard command client to Redis server.
 *
 * @param {C.IClientOptions} opts   The options of client.
 *
 * @see C.ICommandClient
 */
export function createCommandClient(opts: Partial<C.IClientOptions>): C.ICommandClient {

    return new CommandClient({
        'host': opts.host ?? Constants.DEFAULT_HOST,
        'port': opts.port ?? Constants.DEFAULT_PORT,
        'decoderFactory': opts.decoderFactory ?? createDecoder,
        'encoderFactory': opts.encoderFactory ?? createEncoder,
        'commandTimeout': opts.commandTimeout ?? Constants.DEFAULT_COMMAND_TIMEOUT,
        'connectTimeout': opts.connectTimeout ?? Constants.DEFAULT_CONNECT_TIMEOUT,
        'queueSize': opts.queueSize ?? Constants.DEFAULT_QUEUE_SIZE,
        'actionOnQueueFull': opts.actionOnQueueFull ?? Constants.DEFAULT_ACTION_ON_QUEUE_FULL,
    }) as any as C.ICommandClient;
}

/**
 * Create a pure protocol client to Redis server.
 *
 * @param {C.IProtocolClientOptions} opts   The options of client.
 *
 * @see C.IProtocolClient
 */
export function createProtocolClient(opts: C.IProtocolClientOptions): C.IProtocolClient {

    return new ProtocolClient(opts);
}

/**
 * Create a subscriber client to Redis server.
 *
 * @param {C.IClientOptions} opts   The options of client.
 *
 * @see C.ISubscriberClient
 */
export function createSubscriberClient(opts: Partial<C.IClientOptions>): C.ISubscriberClient {

    return new SubscriberClient({
        'host': opts.host ?? Constants.DEFAULT_HOST,
        'port': opts.port ?? Constants.DEFAULT_PORT,
        'decoderFactory': opts.decoderFactory ?? createDecoder,
        'encoderFactory': opts.encoderFactory ?? createEncoder,
        'commandTimeout': opts.commandTimeout ?? Constants.DEFAULT_COMMAND_TIMEOUT,
        'connectTimeout': opts.connectTimeout ?? Constants.DEFAULT_CONNECT_TIMEOUT,
        'queueSize': opts.queueSize ?? Constants.DEFAULT_QUEUE_SIZE,
        'actionOnQueueFull': opts.actionOnQueueFull ?? Constants.DEFAULT_ACTION_ON_QUEUE_FULL,
    });
}