Convert all class constructors with a single parameter: An object with a type (Interface) defined, in order to better handle optional parameters, and to simplify coding.
Why do you want it?
To conform with current coding style standards and to facilitate the declaration of new classes.
@h-sifat mentioned this possibility in #54
// with a single object parameter
new Progress({
x: 3,
y: 23,
length: 20,
id: "prog1",
thickness: 1,
style: pStyle,
theme: "htop",
orientation: "horizontal",
});
// with multiple parameters
new Progress("prog1", 20, 1, 3, 23, pStyle, "htop", "horizontal")
How do you implement it?
To implement it you need to
Take some time to create the Typescript interfaces of each constructor
Update all constructors and all class instances already called internally
Test that EVERYTHING works exactly as before
Document the newly created types
Run npm run docs to update the code documentation
Update the README.md and explain how to migrate to the new version.
All of this will go into forming the new Major Release (v3), as it compromises backwards compatibility because of the syntax change.
Are you interested in developing this feature?
[X] Yes, I am interested in developing this feature
[ ] No, I am not interested in developing this feature
What do you want?
Convert all class constructors with a single parameter: An object with a type (Interface) defined, in order to better handle optional parameters, and to simplify coding.
Why do you want it?
To conform with current coding style standards and to facilitate the declaration of new classes.
@h-sifat mentioned this possibility in #54
How do you implement it?
To implement it you need to
npm run docsto update the code documentationAll of this will go into forming the new Major Release (v3), as it compromises backwards compatibility because of the syntax change.
Are you interested in developing this feature?