Source: demo/index.js

  1. /**
  2.  * @file
  3.  * @fileoverview A set of example functions with attached assertions.
  4.  */
  6. /**
  7.  * Greets a person by name.
  8.  * @param {String} name - Name of the person to greet
  9.  * @returns {String}
  10.  * 
  11.  * @assert {Assertion} Test1 - John:string=>Hello, John!
  12.  * @assert {Assertion} Test2 - Ben:string=>Hello, John!
  13.  * @assert Test3 - John:string,Ben=>Hello, John and Ben!
  14.  * @assert Test4 - 1:bool=>Hello, true!:string
  15.  * @assert - John=>Hello, John!
  16.  */
  17. function greet(name) {
  18.   return `Hello, ${name}!`
  19. }
  21. /**
  22.  * Adds two numbers together.
  23.  * @param {Number} a
  24.  * @param {Number} b 
  25.  * @returns {Number}
  26.  * 
  27.  * @assert - 1:number,2:number=>3:number
  28.  * @assert - 1:number,2:number=>5:number
  29.  */
  30. function add(a, b) {
  31.   return a + b;
  32. }
  34. /**
  35.  * Returns the name property of an object.
  36.  * @param {Object} object - Object to read name from
  37.  * @returns {String}
  38.  * 
  39.  * @assert ObjectTestJohn - test:object=>John:string
  40.  * @assert ObjectTestBlank - :object=>John:string
  41.  * @assert ClassTestJohn - class:object=>John:string
  42.  */
  43. function objectTest(object) {
  44.   return object.name;
  45. }
  47. /**
  48.  * A test class containing a name.
  49.  */
  50. class TestClass {
  51.   /**
  52.    * A test class that has a name property.
  53.    * @param {String} name - The name to be stored
  54.    */
  55.   constructor(name) {
  56.     this.name = name;
  57.   }
  59.   /**
  60.    * Changes the stored name.
  61.    * @param {String} newName - The new name to be stored
  62.    */
  63.   update(newName) {
  64.     this.name = newName;
  65.   }
  66. }
  68. console.log(greet("John"));
  69. console.log(objectTest({name: "John"}));
  71. module.exports = {
  72.   greet,
  73.   add,
  74.   objectTest,
  75.   TestClass,
  76. }