update devDependencies, add jsdoc lint, fix lint issues
[squeep-api-dingus] / lib / router / path-parameter.js
index 81405948a2ea951b5b404aa4bc1bbe78153df117..7728295250b182f88323a524d48a37f93b43c8cc 100644 (file)
@@ -3,12 +3,15 @@
 const parameters = new Map();
 /**
  * De-duplicating factory of minimal-objects to track the named-parameter parts of path definitions.
- *
- * @property {String} parameter
  */
 class PathParameter extends null {
   static #parameters = parameters;
 
+  /**
+   * 
+   * @param {string} parameter name
+   * @returns {PathParameter} frozen parameter object
+   */
   constructor(parameter) {
     if (!parameter || typeof(parameter) !== 'string') {
       throw new RangeError('parameter must be string');
@@ -26,14 +29,14 @@ class PathParameter extends null {
   }
 
   /**
-   * @returns {String}
+   * @returns {string} parameter string
    */
   toString() {
     return this.parameter;
   }
 
   /**
-   * @returns {String}
+   * @returns {string} parameter string
    */
   toJSON() {
     return this.parameter;