docs: fix JSDoc field for object parameter templateParams in Generator constructor

[imballinst]

Description

Previously, we're using String as the field type of templateParams, which was not correct, since we're bound to use Object.keys() on it and Object.keys() on string results on an array over the characters.

The different behaviors between Object<string, string>, Object, and String can be seen in this sandbox: https://codesandbox.io/s/bold-cache-r4tw43?file=/src/index.js.

Initially I wanted to go with just Object (as I mentioned on the issue), but apparently it accepts all kind of types, including string and numbers (which is wrong), so I went with Record<string, string>. Then, I saw the other object field types in the constructor and they are all using Object<string, T>, so I used that instead for consistency purposes.

generator/lib/generator.js

Line 83 in 76c106b

* @param {Object<String, Boolean | String | String[]>} [options.disabledHooks] Object with hooks to disable. The key is a hook type. If key has "true" value, then the generator skips all hooks from the given type. If the value associated with a key is a string with the name of a single hook, then the generator skips only this single hook name. If the value associated with a key is an array of strings, then the generator skips only hooks from the array.

As we could see from the sandbox, the result is as the following:

/**
 *
 * @param {Object<string, string>} param
 */
function testFnObjectWithTypes(param) {}

testFnObjectWithTypes(123); // TypeError
testFnObjectWithTypes(""); // TypeError
testFnObjectWithTypes({}); // ok
testFnObjectWithTypes({ hello: "world" }); // ok

Related issue(s)

Fixes #985.

[github-actions]

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[derberg]

lgtm @imballinst no need for fix prefix and the release as we are still not exposing any ts interfaces or whatsoever, so just docs need update.

[derberg]

/rtm

@Florence-Njeri fyi, as docs related. As it is docs, there will an automated PR to update API docs

[asyncapi-bot]

🎉 This PR is included in version 1.10.10 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀