IBM/node-celery-ts

// 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.

/**
 * encapsulates encoding and decoding of arbitrary binary data into text
 */
export interface Encoder {
    encode(data: Buffer): string;

    decode(data: string): Buffer;
}

/**
 * uses Buffer.toString() and Buffer.from() with encoding "utf8"
 *
 * @returns an Encoder that interprets its inputs as UTF-8 encoded text
 */
export const createPlaintextEncoder = (): Encoder => ({
    encode: (data: Buffer): string => data.toString("utf8"),

    decode: (data: string): Buffer => Buffer.from(data, "utf8"),
});

/**
 * uses Buffer.toString() and Buffer.from() with encoding "base64"
 *
 * @returns an Encoder that uses the Base64 encoding method
 */
export const createBase64Encoder = (): Encoder => ({
    encode: (data: Buffer): string => data.toString("base64"),

    decode: (data: string): Buffer => Buffer.from(data, "base64"),
});