@microfocus/alm-octane-js-rest-sdk
Version:
NodeJS wrapper for the Open Text ALM Octane API
101 lines (100 loc) • 4.08 kB
JavaScript
;
/*
* Copyright 2020-2023 Open Text.
*
* The only warranties for products and services of Open Text and
* its affiliates and licensors (“Open Text”) are as may be set forth
* in the express warranty statements accompanying such products and services.
* Nothing herein should be construed as constituting an additional warranty.
* Open Text shall not be liable for technical or editorial errors or
* omissions contained herein. The information contained herein is subject
* to change without notice.
*
* Except as specifically indicated otherwise, this document contains
* confidential information and a valid license is required for possession,
* use or copying. If this work is provided to the U.S. Government,
* consistent with FAR 12.211 and 12.212, Commercial Computer Software,
* Computer Software Documentation, and Technical Data for Commercial Items are
* licensed to the U.S. Government under vendor's standard commercial license.
*
* 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
* http://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.
*/
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.trim = exports.toDisplayName = exports.toCamelCase = exports.extend = void 0;
/** @module octane/utils */
const pluralize_1 = __importDefault(require("pluralize"));
/**
* Shallow copy of properties from the `src` object to the `dest` object. If the
* `noOverwrite` argument is set to to `true`, the value of a property in `src`
* will not be overwritten if it already exists.
*
* @param {Object} dest - destination object
* @param {Object} src - source object
* @param {Boolean} noOverwrite - set to `true` to overwrite values in `src`
**/
const extend = function extend(dest, src, noOverwrite) {
for (const prop in src) {
if (!noOverwrite || typeof dest[prop] === 'undefined') {
dest[prop] = src[prop];
}
}
return dest;
};
exports.extend = extend;
/**
* Transform a string that contains spaces, underscore, or dashes to CamelCase.
* If 'lower' is set to 'true', the string will be transformed to camelCase.
*
* @param {String} str - string to transform
* @param {Boolean} [lower] - set to 'true' to transform to camelCase
*/
const toCamelCase = (str, lower) => {
str = str
.toLowerCase()
.replace(/(?:(^.)|(\s+.)|(_.)|(-.))/g, (match) => match.charAt(match.length - 1).toUpperCase());
if (lower) {
str = str.charAt(0).toLowerCase() + str.substr(1);
}
return str;
};
exports.toCamelCase = toCamelCase;
/**
* Transform a string that contains underscore to words.
* If 'plural' is set to 'true', the string will be transformed to the plural words.
*
* @param {String} str - string to transform
* @param {Boolean} [plural] - set to 'true' to transform to the plural words
*/
const toDisplayName = function toDisplayName(str, plural) {
const words = str.toLowerCase().split('_');
if (plural && words.length > 0) {
const index = words.length - 1;
words[index] = pluralize_1.default.plural(words[index]);
}
return words.join(' ');
};
exports.toDisplayName = toDisplayName;
/**
* Remove whitespace from both sides of a string.
* If 'str' is not a string, return it directly.
*
* @param {String} str - string to trim
*/
const trim = function trim(str) {
if (typeof str !== 'string') {
return str;
}
return str.replace(/^[\s\t\r\n]+/, '').replace(/[\s\t\r\n]+$/, '');
};
exports.trim = trim;