input-validator.js 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. /*
  2. * Copyright 2018 Scytl Secure Electronic Voting SA
  3. *
  4. * All rights reserved
  5. *
  6. * See our extended copyright notice in *file 'Copyright.txt' which is part of this source code package
  7. */
  8. /* jshint node:true */
  9. 'use strict';
  10. /**
  11. * Input data validation utility for this module. Only intended for internal
  12. * use.
  13. */
  14. module.exports = {
  15. /**
  16. * Checks if a value is defined.
  17. *
  18. * @function checkIsDefined
  19. * @private
  20. * @param {Object}
  21. * value The value to check.
  22. * @param {string}
  23. * label The error message label for the value.
  24. * @throws {TypeError}
  25. * If the value is undefined.
  26. */
  27. checkIsDefined: function(value, label) {
  28. if (typeof value === 'undefined') {
  29. throw new TypeError(label + ' is undefined.');
  30. }
  31. },
  32. /**
  33. * Checks if a value is not null.
  34. *
  35. * @function checkIsNotNull
  36. * @private
  37. * @param {Object}
  38. * value The value to check.
  39. * @param {string}
  40. * label The error message label for the value.
  41. * @throws {TypeError}
  42. * If the value is null.
  43. */
  44. checkIsNotNull: function(value, label) {
  45. if (value === null) {
  46. throw new TypeError(label + ' is null.');
  47. }
  48. },
  49. /**
  50. * Checks if a value is defined and not null.
  51. *
  52. * @function checkIsDefinedAndNotNull
  53. * @private
  54. * @param {Object}
  55. * value The value to check.
  56. * @param {string}
  57. * label The error message label for the value.
  58. * @throws {TypeError}
  59. * If the value is not defined or it is null.
  60. */
  61. checkIsDefinedAndNotNull: function(value, label) {
  62. this.checkIsDefined(value, label);
  63. this.checkIsNotNull(value, label);
  64. },
  65. /**
  66. * Checks if a value is an object.
  67. *
  68. * @function checkIsObject
  69. * @private
  70. * @param {Object}
  71. * value The value to check.
  72. * @param {string}
  73. * label The error message label for the value.
  74. * @throws {TypeError}
  75. * If the value is not an object.
  76. */
  77. checkIsObject: function(value, label) {
  78. if (typeof value !== 'object') {
  79. throw new TypeError(label + ' is not an object.');
  80. }
  81. },
  82. /**
  83. * Checks if a value is an object and has properties.
  84. *
  85. * @function checkIsObjectWithProperties
  86. * @private
  87. * @param {Object}
  88. * value The value to check.
  89. * @param {string}
  90. * label The error message label for the value.
  91. * @throws {TypeError}
  92. * If the value is not an object or it has no properties.
  93. */
  94. checkIsObjectWithProperties: function(value, label) {
  95. this.checkIsDefinedAndNotNull(value, label);
  96. this.checkIsObject(value, label);
  97. if (!Object.getOwnPropertyNames(value).length) {
  98. throw new Error(label + ' does not have any properties.');
  99. }
  100. }
  101. };