adding types to jsdocs

Author: Zhan Milenkov

src/core/errors.mjs

@@ -14,15 +14,17 @@
  * limitations under the License.
  *
  */
+'use strict'
+
 export class FullstackTestingError extends Error {
   /**
      * Create a custom error object
      *
      * error metadata will include the `cause`
      *
-     * @param message error message
-     * @param cause source error (if any)
-     * @param meta additional metadata (if any)
+     * @param {string} message error message
+     * @param {Error | Object} cause source error (if any)
+     * @param {Object} meta additional metadata (if any)
      */
   constructor (message, cause = {}, meta = {}) {
     super(message)
@@ -43,9 +45,9 @@ export class ResourceNotFoundError extends FullstackTestingError {
      *
      * error metadata will include `resource`
      *
-     * @param message error message
-     * @param resource name of the resource
-     * @param cause source error (if any)
+     * @param {string} message - error message
+     * @param {string} resource - name of the resource
+     * @param {Error|Object} cause - source error (if any)
      */
   constructor (message, resource, cause = {}) {
     super(message, cause, { resource })
@@ -56,8 +58,8 @@ export class MissingArgumentError extends FullstackTestingError {
   /**
      * Create a custom error for missing argument scenario
      *
-     * @param message error message
-     * @param cause source error (if any)
+     * @param {string} message - error message
+     * @param {Error|Object} cause - source error (if any)
      */
   constructor (message, cause = {}) {
     super(message, cause)
@@ -70,9 +72,9 @@ export class IllegalArgumentError extends FullstackTestingError {
      *
      * error metadata will include `value`
      *
-     * @param message error message
-     * @param value value of the invalid argument
-     * @param cause source error (if any)
+     * @param {string} message - error message
+     * @param {*} value - value of the invalid argument
+     * @param {Error|Object} cause - source error (if any)
      */
   constructor (message, value = '', cause = {}) {
     super(message, cause, { value })
@@ -85,10 +87,10 @@ export class DataValidationError extends FullstackTestingError {
      *
      * error metadata will include `expected` and `found` values.
      *
-     * @param message error message
-     * @param expected expected value
-     * @param found value found
-     * @param cause source error (if any)
+     * @param {string} message - error message
+     * @param {*} expected - expected value
+     * @param {*} found - value found
+     * @param {Error|Object} [cause] - source error (if any)
      */
   constructor (message, expected, found, cause = {}) {
     super(message, cause, { expected, found })

src/core/helm.mjs

@@ -14,6 +14,7 @@
  * limitations under the License.
  *
  */
+'use strict'
 import os from 'os'
 import { constants } from './index.mjs'
 import { ShellRunner } from './shell_runner.mjs'

src/core/helpers.mjs

@@ -14,6 +14,7 @@
  * limitations under the License.
  *
  */
+'use strict'
 import fs from 'fs'
 import os from 'os'
 import path from 'path'
@@ -32,7 +33,7 @@ const CUR_FILE_DIR = paths.dirname(fileURLToPath(import.meta.url))
 
 /**
  * @param {number} ms
- * @returns {Promise}
+ * @returns {Promise<void>}
  */
 export function sleep (ms) {
   return new Promise((resolve) => {
@@ -305,7 +306,7 @@ export function getNodeAccountMap (nodeIDs) {
 /**
  * @param {AccountManager} accountManager
  * @param {string} namespace
- * @param fileNum
+ * @param {number} fileNum
  * @returns {Promise<string>}
  */
 export async function getFileContents (accountManager, namespace, fileNum) {
@@ -316,11 +317,20 @@ export async function getFileContents (accountManager, namespace, fileNum) {
   return Buffer.from(await queryFees.execute(client)).toString('hex')
 }
 
+/**
+ * @param {Array} envVarArray
+ * @param {string} name
+ * @returns {string|null}
+ */
 export function getEnvValue (envVarArray, name) {
   const kvPair = envVarArray.find(v => v.startsWith(`${name}=`))
   return kvPair ? kvPair.split('=')[1] : null
 }
 
+/**
+ * @param {string} ipAddress
+ * @returns {Uint8Array}
+ */
 export function parseIpAddressToUint8Array (ipAddress) {
   const parts = ipAddress.split('.')
   const uint8Array = new Uint8Array(4)

src/core/k8.mjs

@@ -14,6 +14,7 @@
  * limitations under the License.
  *
  */
+'use strict'
 import * as k8s from '@kubernetes/client-node'
 import fs from 'fs'
 import net from 'net'
@@ -62,6 +63,9 @@ export class K8 {
     return c.init()
   }
 
+  /**
+   * @returns {k8s.KubeConfig}
+   */
   getKubeConfig () {
     return this.kubeConfig
   }
@@ -92,7 +96,7 @@ export class K8 {
    * Apply filters to metadata
    * @param {Array} items - list of items
    * @param {Object} [filters] - an object with metadata fields and value
-   * @returns a list of items that match the filters
+   * @returns {Array} a list of items that match the filters
    */
   applyMetadataFilter (items, filters = {}) {
     if (!filters) throw new MissingArgumentError('filters are required')
@@ -160,7 +164,7 @@ export class K8 {
 
   /**
    * Get a list of namespaces
-   * @returns list of namespaces
+   * @returns {string[]} list of namespaces
    */
   async getNamespaces () {
     const resp = await this.kubeClient.listNamespace()
@@ -440,6 +444,12 @@ export class K8 {
     ) === 'true'
   }
 
+  /**
+   * @param {string} podName
+   * @param {string} containerName
+   * @param {string} destPath
+   * @returns {Promise<string>}
+   */
   async mkdir (podName, containerName, destPath) {
     return this.execContainer(
       podName,
@@ -453,7 +463,7 @@ export class K8 {
    *
    * It overwrites any existing file inside the container at the destination directory
    *
-   * @param {string} podName - podName name
+   * @param {string} podName
    * @param {string} containerName
    * @param {string} srcPath - source file path in the local
    * @param {string} destDir - destination directory in the container
@@ -519,7 +529,7 @@ export class K8 {
    *
    * It overwrites any existing file at the destination directory
    *
-   * @param {string} podName - podName name
+   * @param {string} podName
    * @param {string} containerName
    * @param {string} srcPath - source file path in the container
    * @param {string} destDir - destination directory in the local