One thing I've noticed is that the JSDoc types for parameters which are optional aren't marked as so, so my editor tends to complain when I use dockerode with no params and Promises. Optional parameters in JSDoc are indicated with square brackets.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Open a new issue if needed.
Hi! Love
dockerode
😀One thing I've noticed is that the JSDoc types for parameters which are optional aren't marked as so, so my editor tends to complain when I use
dockerode
with no params and Promises. Optional parameters in JSDoc are indicated with square brackets.For example,
container.inspect
allows for optionalopts
andcallback
: https://github.com/apocas/dockerode/blob/bb88194ff250c4f5b9a0eee2688c5dcc5f623ef9/lib/container.js#L41-L46In this example, the parameter types should be: