Function getPassword

packages/bitcore-cli/src/prompts.ts:67–99

(
  /** Optional message to display to the user. Otherwise, defaults to 'Password:' */
  msg?: string,
  /** Optional settings for the password prompt. */
  opts?: {
    /** Minimum length for the password. Defaults to 0. */
    minLength?: number;
    /** Whether the password input should be hidden. Defaults to true. */
    hidden?: boolean;
    /** Custom validation function for the password input. Note, this does NOT override the minimum length check. */
    validate?: (input: string) => string | null;
  }
)

 * @returns The entered password as a string.
 */
export async function getPassword(
  /** Optional message to display to the user. Otherwise, defaults to 'Password:' */
  msg?: string,
  /** Optional settings for the password prompt. */
  opts?: {
    /** Minimum length for the password. Defaults to 0. */
    minLength?: number;
    /** Whether the password input should be hidden. Defaults to true. */
    hidden?: boolean;
    /** Custom validation function for the password input. Note, this does NOT override the minimum length check. */
    validate?: (input: string) => string | null;
  }
): Promise<string> {
  opts = opts || {};
  opts.minLength = opts.minLength ?? 0;
  const hidden = opts.hidden ?? true;

  const password = await prompt.password({
    message: (msg || 'Password:') + (hidden ? ' (hidden)' : ''),
    mask: hidden ? '' : undefined,
    clearOnError: hidden,
    validate: (input) => {
      if (input?.length < opts.minLength) {
        return `Password must be at least ${opts.minLength} characters long.`;
      }
      return opts.validate?.(input);
    }
  });
  if (prompt.isCancel(password)) {
    throw new UserCancelled();
  }
  return password as string;
};

/**
 * Prompts the user to enter an M-of-N scheme for multi-signature wallets, with validation.