IBM/node-celery-ts

View on GitHub
src/redis/uri/common.ts

Summary

Maintainability
A
0 mins
Test Coverage
// BSD 3-Clause License
//
// Copyright (c) 2018, IBM Corporation
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice, this
//   list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright notice,
//   this list of conditions and the following disclaimer in the documentation
//   and/or other materials provided with the distribution.
//
// * Neither the name of the copyright holder nor the names of its
//   contributors may be used to endorse or promote products derived from
//   this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

import { createBooleanQueryDescriptor, QueryParser } from "../../query_parser";
import { Uri } from "../../uri";
import { isNullOrUndefined } from "../../utility";

/**
 * Redis options common to several connection types.
 */
export interface RedisQueryOptions {
    noDelay?: boolean;
    password?: string;
}

/**
 * @param uri The object representation of a Redis URI.
 * @returns A `RedisQueryOptions` object with options present in `uri` mapped.
 *
 * @throws ParseError If the query could not be parsed.
 */
export const parseRedisQuery = (uri: Uri): RedisQueryOptions => {
    if (isNullOrUndefined(uri.query)) {
        return { };
    }

    const parser = new QueryParser<RedisQueryOptions>([
        { source: "password" },
        createBooleanQueryDescriptor("noDelay"),
    ]);

    return parser.parse(uri.query, { });
};