jsdoc @returns - 带可选参数的返回函数

Question

我有一个返回的钩子：

/**
 *
 * @returns {[
 *   AuthState,
 *   (providerName: string, redirectSignIn: boolean) => Promise<boolean>,
 *   () => Promise<void>
 * ]}
 */

如何将redirectSignIn参数描述为可选？

Answer 1

尝试添加默认值“未定义”

/**
 *
 * @returns {[
 *   AuthState,
 *   (providerName: string, redirectSignIn: boolean=undefined) => Promise<boolean>,
 *   () => Promise<void>
 * ]}
 */

在我的案例中起作用：

@returns {(function(api:object, action:string, args:array, opts:object=undefined, cb:function=undefined): Promise|void)}