@cumulus/common/util.js

"use strict";
/**
 * Simple utility functions
 * @module util
 */
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
    Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
    o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
    if (mod && mod.__esModule) return mod;
    var result = {};
    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
    __setModuleDefault(result, mod);
    return result;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.isOneOf = exports.removeNilProperties = exports.deprecate = void 0;
const curry_1 = __importDefault(require("lodash/curry"));
const isNil_1 = __importDefault(require("lodash/isNil"));
const omitBy_1 = __importDefault(require("lodash/omitBy"));
const log = __importStar(require("./log"));
/**
 * Mark a piece of code as deprecated.
 *
 * Each deprecation notice for a given name and version combination will
 * only be printed once.
 *
 * @param {string} name - the name of the function / method / class to deprecate
 * @param {string} version - the version after which the code will be marked
 *   as deprecated
 * @param {string} [alternative] - the function / method / class to use instead
 *   of this deprecated code
 *
 * @alias module:util
 */
exports.deprecate = (() => {
    const warned = new Set();
    return (name, version, alternative) => {
        const key = `${name}-${version}`;
        if (warned.has(key))
            return;
        warned.add(key);
        let message = `${name} is deprecated after version ${version} and will be removed in a future release.`;
        if (alternative)
            message += ` Use ${alternative} instead.`;
        log.warn(message);
    };
})();
/**
 * Remove properties whose values are `null` or `undefined`
 *
 * @param {Object} obj - object to update
 * @returns {Object} a shallow clone of the object with `null` and `undefined`
 *   properties removed
 *
 * @alias module:util
 */
exports.removeNilProperties = (obj) => omitBy_1.default(obj, isNil_1.default);
/**
 * Test if a value is included in a list of items
 *
 * This is a curried function - https://lodash.com/docs/4.17.11#curry
 *
 * @param {Array} collection - the list of items to check against
 * @param {Object} val - the item to check for in the collection
 * @returns {boolean}
 *
 * @alias module:util
 * @kind function
 */
exports.isOneOf = curry_1.default((collection, val) => collection.includes(val), 2);
//# sourceMappingURL=util.js.map