@returns 屬性上的 JsDoc 類型聯合

Question

這個例子可能是一個奇怪的模式，我可能會改變它，但這讓我想知道是否可以在 JsDoc 的@returns屬性上定義聯合類型。 這是使其更明確的示例：

  function isInputValid(email: string, password: string): string | void {
    /**
     * Verify user email and password inputs.
     * @param {string} email - The user email input.
     * @param {string} password - The user password input.
     * @returns {boolean | void} The invalid user input.
     */
    if (!validEmail(email)) {
      return email;
    }

    if (!validPassword(password)) {
      return password;
    }
  }

Answer 1

請參閱此處有關 @return 的 JSDoc 文檔。

你很接近，只是缺少一些括號() 。

/**
 * Verify user email and password inputs.
 * @param {string} email - The user email input.
 * @param {string} password - The user password input.
 * @returns {(boolean|void)} The invalid user input.
 */

希望這可以幫助。