index.js

Filename	Percent	Threshold	Total	Covered	Uncovered
src/index.js	44.35%	80%	115	51	64

// @ts-check
// SPDX-License-Identifier: Zlib
// SPDX-FileCopyrightText: 2024 CERN (home.cern)
// SPDX-Created: 2024-02-06T14:20:41
// SPDX-FileContributor: Author: Sylvain Fargier <sylvain.fargier@cern.ch>

import * as prom from "./prom.js";
export * from "./prom.js";
export { prom };
export * from "./VarBuffer.js";
export * from "./IOBuffer.js";

/**
 * @brief check if maybe object/array is empty
 * @param {any} value
 * @returns {boolean} true if object is empty or not an enumerable
 */
export function isEmpty(value) {
  return (value?.length ?? value?.size ??
    ((value instanceof Object && Object.entries(value).length) || 0)) === 0;
}

/**
 * @brief test if object is null or undefined
 * @param {any} value
 * @returns {boolean} true if value is nullish
 */
export function isNil(value) {
  return value === undefined || value === null;
}

/**
 * @brief get last element of maybe list
 * @template T
 * @param {T[]|any} value
 * @returns {T|undefined}
 */
export function last(value) {
  const len = value?.length;
  if (isNaN(len)) { return undefined; }

  return value[len - 1];
}

/**
 * @brief get first element of maybe list
 * @template T
 * @param {T[]|any} value
 * @returns {T|undefined}
 */
export function first(value) {
  const len = value?.length; // identify arrays
  if (isNaN(len)) { return undefined; }

  return value[0];
}

/**
 * @brief try to recursively set a value on object
 * @param {any} obj
 * @param {(string|number)[]|any} path
 * @param {any} value
 * @returns {any|null} input object or null on error
 */
export function set(obj, path, value) {
  try {
    let leaf = obj;

    for (let i = 0; i < (path?.length ?? 0) - 1; ++i) {
      if (!(leaf instanceof Object)) { return null; }

      const pathPart = path[i];

      let child = leaf[pathPart];
      if (!(child instanceof Object)) {
        child = {};
        leaf[pathPart] = child;
      }
      leaf = child;
    }
    const key = last(path);
    if (!(leaf instanceof Object) || key === undefined) { return null; }
    leaf[last(path)] = value;
  }
  catch {
    return null;
  }
  return obj;
}

/**
 * @brief deeply clone object (native implementation)
 * @template T
 * @param {T} value
 * @return {T}
 */
export function cloneDeep(value) {
  return structuredClone(value);
}

/**
 * @brief merge sources in target
 * @param {any} target
 * @param  {any[]} sources
 * @returns {any}
 */
export function merge(target, ...sources) {
  if (!(target instanceof Object)) {
    target = {};
  }
  sources.forEach((source) => {
    if (!(source instanceof Object)) { return; }

    Object.entries(source).forEach(([ key, value ]) => {
      const targetValue = target[key];
      if (value === undefined) {
        /* skip as in lodash */
      }
      else if (value instanceof Object && targetValue instanceof Object) {
        merge(targetValue, value);
      }
      else {
        target[key] = cloneDeep(value);
      }
    });
  });

  return target;
}

[{"file":"src/index.js","line":17,"character":24,"text":"value","kind":1},{"file":"src/index.js","line":18,"character":10,"text":"value","kind":1},{"file":"src/index.js","line":18,"character":17,"text":"length","kind":1},{"file":"src/index.js","line":18,"character":27,"text":"value","kind":1},{"file":"src/index.js","line":18,"character":34,"text":"size","kind":1},{"file":"src/index.js","line":19,"character":6,"text":"value","kind":1},{"file":"src/index.js","line":27,"character":22,"text":"value","kind":1},{"file":"src/index.js","line":28,"character":9,"text":"value","kind":1},{"file":"src/index.js","line":28,"character":32,"text":"value","kind":1},{"file":"src/index.js","line":37,"character":21,"text":"value","kind":1},{"file":"src/index.js","line":38,"character":8,"text":"len","kind":1},{"file":"src/index.js","line":38,"character":14,"text":"value","kind":1},{"file":"src/index.js","line":38,"character":21,"text":"length","kind":1},{"file":"src/index.js","line":41,"character":9,"text":"value","kind":1},{"file":"src/index.js","line":41,"character":15,"text":"len","kind":1},{"file":"src/index.js","line":50,"character":22,"text":"value","kind":1},{"file":"src/index.js","line":51,"character":8,"text":"len","kind":1},{"file":"src/index.js","line":51,"character":14,"text":"value","kind":1},{"file":"src/index.js","line":51,"character":21,"text":"length","kind":1},{"file":"src/index.js","line":54,"character":9,"text":"value","kind":1},{"file":"src/index.js","line":64,"character":20,"text":"obj","kind":1},{"file":"src/index.js","line":64,"character":25,"text":"path","kind":1},{"file":"src/index.js","line":64,"character":31,"text":"value","kind":1},{"file":"src/index.js","line":66,"character":8,"text":"leaf","kind":1},{"file":"src/index.js","line":66,"character":15,"text":"obj","kind":1},{"file":"src/index.js","line":68,"character":25,"text":"path","kind":1},{"file":"src/index.js","line":68,"character":31,"text":"length","kind":1},{"file":"src/index.js","line":69,"character":12,"text":"leaf","kind":1},{"file":"src/index.js","line":71,"character":12,"text":"pathPart","kind":1},{"file":"src/index.js","line":71,"character":23,"text":"path","kind":1},{"file":"src/index.js","line":73,"character":10,"text":"child","kind":1},{"file":"src/index.js","line":73,"character":18,"text":"leaf","kind":1},{"file":"src/index.js","line":73,"character":23,"text":"pathPart","kind":1},{"file":"src/index.js","line":74,"character":12,"text":"child","kind":1},{"file":"src/index.js","line":75,"character":8,"text":"child","kind":1},{"file":"src/index.js","line":76,"character":8,"text":"leaf","kind":1},{"file":"src/index.js","line":76,"character":13,"text":"pathPart","kind":1},{"file":"src/index.js","line":76,"character":25,"text":"child","kind":1},{"file":"src/index.js","line":78,"character":6,"text":"leaf","kind":1},{"file":"src/index.js","line":78,"character":13,"text":"child","kind":1},{"file":"src/index.js","line":80,"character":10,"text":"key","kind":1},{"file":"src/index.js","line":80,"character":21,"text":"path","kind":1},{"file":"src/index.js","line":81,"character":10,"text":"leaf","kind":1},{"file":"src/index.js","line":81,"character":37,"text":"key","kind":1},{"file":"src/index.js","line":82,"character":4,"text":"leaf","kind":1},{"file":"src/index.js","line":82,"character":14,"text":"path","kind":1},{"file":"src/index.js","line":82,"character":23,"text":"value","kind":1},{"file":"src/index.js","line":87,"character":9,"text":"obj","kind":1},{"file":"src/index.js","line":106,"character":22,"text":"target","kind":1},{"file":"src/index.js","line":107,"character":8,"text":"target","kind":1},{"file":"src/index.js","line":108,"character":4,"text":"target","kind":1},{"file":"src/index.js","line":110,"character":19,"text":"source","kind":1},{"file":"src/index.js","line":111,"character":10,"text":"source","kind":1},{"file":"src/index.js","line":113,"character":43,"text":"value","kind":1},{"file":"src/index.js","line":114,"character":12,"text":"targetValue","kind":1},{"file":"src/index.js","line":114,"character":26,"text":"target","kind":1},{"file":"src/index.js","line":115,"character":10,"text":"value","kind":1},{"file":"src/index.js","line":118,"character":15,"text":"value","kind":1},{"file":"src/index.js","line":118,"character":42,"text":"targetValue","kind":1},{"file":"src/index.js","line":119,"character":14,"text":"targetValue","kind":1},{"file":"src/index.js","line":119,"character":27,"text":"value","kind":1},{"file":"src/index.js","line":122,"character":8,"text":"target","kind":1},{"file":"src/index.js","line":122,"character":32,"text":"value","kind":1},{"file":"src/index.js","line":127,"character":9,"text":"target","kind":1}]

TypeScript coverage report