/**
 * Copyright 2024 Resultium LLC
 *
 * This file is part of @resultium/utils.
 *
 * @resultium/utils is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 *
 * @resultium/utils is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with RCZ. If not, see <https://www.gnu.org/licenses/>.
 */

/**
 * Conditionally joins given strings
 *
 * @example
 * ```ts
 * let isAdmin = true
 *
 * // prints "Hello, Administrator!"
 * console.log(conditionalJoin(["Hello,", isAdmin ? "Administrator" : "User", "!"], " "))
 * ```
 *
 * @param array - strings to join
 * @param joinChar - character used to join strings
 * @returns new string
 */
export const conditionalJoin = (array: Array<string>, joinChar: string) =>
  array.filter(Boolean).join(joinChar);