lib/handlebar-helpers.js

  1. // Copyright 2018 Google Inc. All Rights Reserved.
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. //      http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  15. 'use strict';
  17. /**
  18.  * @namespace templateHelpers
  19.  */
  21. module.exports = {
  22.   notEmptyObject: notEmptyObject,
  23.   json: json,
  24.   isNotDefaultStatusCode: isNotDefaultStatusCode
  25. }
  27. /**
  28.  * determines if the given object is empty or not
  29.  * @function notEmptyObject
  30.  * @memberof templateHelpers
  31.  * @instance
  32.  * @param {object} obj object to be evaluated
  33.  * @return {boolean}
  34.  */
  35. function notEmptyObject(obj) {
  36.   if (arguments.length < 1) {
  37.     throw new Error('Handlebars Helper \'notEmptyObject\' needs 1 parameter');
  38.   }
  40.   return obj !== undefined && Object.keys(obj).length !== 0
  41. }
  43. /**
  44.  * stringifies the given JSON object
  45.  * @function json
  46.  * @memberof templateHelpers
  47.  * @instance
  48.  * @param {object} obj JSON object to be stringified
  49.  * @return {string}
  50.  */
  51. function json(obj) {
  52.   if (arguments.length < 1) {
  53.     throw new Error('Handlebars Helper \'json\' needs 1 parameter');
  54.   }
  56.   return JSON.stringify(obj)
  57. }
  59. /**
  60.  * determines if the given status code is the 'default' status
  61.  * @function isNotDefaultStatusCode
  62.  * @memberof templateHelpers
  63.  * @instance
  64.  * @param {(string | number)} code status code to check
  65.  * @return {boolean}
  66.  */
  67. function isNotDefaultStatusCode(code) {
  68.   if (arguments.length < 1) {
  69.     throw new Error(
  70.         'Handlebars Helper \'isNotDefaultStatusCode\' needs 1 parameter');
  71.   }
  73.   return code !== 'default'
  74. }