Migrating lib/api/client-commands/_base-command.js to typescript

[itsspriyansh]

I made changes to change the code from javascript to typescript but there are some typescript errors I am facing regarding which I need some guidance.

Line 61: Parameter '_' implicitly has an 'any' type.ts(7006)
Line 61: Parameter 'err' implicitly has an 'any' type.ts(7006)
Line 82: Property 'performAction' does not exist on type 'ClientCommand'.ts(2339)
Line 104, 105: Property 'originalTarget' does not exist on type 'string | Function'.
Property 'originalTarget' does not exist on type 'string'.ts(2339)
Line 115: Property 'transportActions' does not exist on type 'ClientCommand'.ts(2339)

[github-actions]

Status

• ❌ No modified files found in the types directory.
  Please make sure to include types for any changes you have made. Thank you!.

[garg3133]

We should create an interface for the parameters of a function only if we want to reuse it, otherwise just put the type beside each property in parameter:

static makePromise({
      performAction: (callback: (result: ResultObject) => void) => void,
      userSuppliedCallback: ((param : any) => any) = function() {}, 
      fullResultObject: boolean = true, 
      fullPromiseResolve: boolean = true
    }) : Promise<unknown> {}

[garg3133]

We should mention all the properties available on this at the top of the class, along with public/private keywords.

[garg3133]

We don't want to use any anywhere, unless absolutely necessary. So, we would need to make changes in the argument itself to accommodate originalTarget as well.

Ex. script: string | Function | {originalTarget: string | Function}

And then try to implement the DRY principal (string | Function are repeating twice above).

[garg3133]

Should be export = class ClientCommand, if it is being imported in other JS files, so that we don't need to make any changes in those JS files. (export = is similar to module.exports = in JS)

^ is the reason why the tests are failing.

And when converting those JS files (in which ClientCommand is being used) to TS, we will use import ClientCommand = require('./_base-command.js'); instead of import ClientCommand from './_base-command.js';.

Once we are sure that we are importing this file in TS files only, we can change the export back to export default class ClientCommand, and the imports in other TS files to import ClientCommand from './_base-command.js';.