ordering.ts

/**
 *  SudoSOS back-end API service.
 *  Copyright (C) 2024  Study association GEWIS
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as published
 *  by the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

export enum OrderingDirection {
  ASC = 'ASC',
  DESC = 'DESC',
  asc = 'asc',
  desc = 'desc',
}

/**
 * Convert the given input to an OrderingDirection object or undefined if correct. Throw error otherwise
 * @throws TypeError input not a valid OrderingDirection
 * @param input
 */
export function asOrderingDirection(input?: any): OrderingDirection | undefined {
  if (input === undefined) return undefined;
  if (!Object.values(OrderingDirection).includes(input as any)) {
    throw new TypeError(`Input '${input}' is not a valid OrderingDirection`);
  }

  return input as OrderingDirection;
}