tools/utils/src/modules/any-any.js

  1. /**
  2. * @module @svizzle/utils/any-any
  3. */
  5. import * as _ from 'lamb';
  7. import {isValidNumber} from './any-boolean.js';
  9. /**
  10.  * Return an empty array if the input is undefined or identity otherwise.
  11.  *
  12.  * @function
  13.  * @arg {*} any
  14.  * @return {(*|array)}
  15.  *
  16.  * @example
  17. > makeEmptyArrayIfUndefined(undefined)
  18. []
  19. > makeEmptyArrayIfUndefined([1, 2, 3])
  20. [1, 2, 3]
  21. > makeEmptyArrayIfUndefined({a: 1})
  22. {a: 1}
  23. > makeEmptyArrayIfUndefined('a')
  24. 'a'
  25.  *
  26.  * @since 0.1.0
  27.  */
  28. export const makeEmptyArrayIfUndefined = x => _.isUndefined(x) ? [] : x;
  30. /**
  31.  * Return a number if the input can be converted to float, identity otherwise
  32.  *
  33.  * @function
  34.  * @arg {*} any
  35.  * @return {number|*}
  36.  *
  37.  * @example
  38. > toFloatOrIdentity('2')
  39. 2
  40. > toFloatOrIdentity('2px')
  41. 2
  42. > toFloatOrIdentity('')
  43. ''
  44. > toFloatOrIdentity('h2o')
  45. 'h2o'
  46. > toFloatOrIdentity([1.1])
  47. 1.1
  48. > toFloatOrIdentity([1.1, 2])
  49. 1.1
  50. > toFloatOrIdentity([1.1, 2, 3])
  51. 1.1
  52. > toFloatOrIdentity([])
  53. []
  54. > toFloatOrIdentity({a: 1})
  55. {a: 1}
  56. > toFloatOrIdentity(true)
  57. true
  58. > toFloatOrIdentity(null)
  59. null
  60. > toFloatOrIdentity(undefined)
  61. undefined
  62.  * @since 0.1.0
  63.  */
  64. export const toFloatOrIdentity = x => {
  65. 	const parsed = parseFloat(x);
  67. 	return isValidNumber(parsed) ? parsed : x;
  68. };
  70. /**
  71.  * Return a copy of the input after stringifying it and parsing it.
  72.  * This can be useful to check equality of json variables with json objects
  73.  * obtained from a file, because e.g. stringifying strips `undefined` values.
  74.  *
  75.  * @function
  76.  * @arg {*} any
  77.  * @return {*} any
  78.  *
  79.  * @example
  80.  *
  81. > actual = {a: 1, b: undefined}
  82. {a: 1, b: undefined}
  83. >
  84. > // note how `JSON.stringify` works
  85. > JSON.stringify(actual)
  86. '{"a":1}'
  87. >
  88. > expectedFromFile = {a: 1}
  89. > assert.deepStrictEqual(actual, expectedFromFile)
  90. Uncaught AssertionError [ERR_ASSERTION]: Expected values to be strictly deep-equal:
  91. + actual - expected
  93.   {
  94.     a: 1,
  95. +   b: undefined
  96.   }
  97. >
  98. > sanitizedObj = sanitize(actual)
  99. > assert.deepStrictEqual(sanitizedObj, expectedFromFile)
  100. undefined
  102. > array = [1, undefined]
  103. > sanitize(array)
  104. [1, null]
  105.  *
  106.  * @since 0.17.0
  107.  */
  108. export const sanitize = _.pipe([JSON.stringify, JSON.parse]);