bananass/src/core/structs/problem/problem.js

Baekjoon Framework for JavaScript.🍌

/**
 * @fileoverview `Problem` type struct.
 */

// --------------------------------------------------------------------------------
// Import
// --------------------------------------------------------------------------------

import { refine, string } from 'superstruct';
import { BAEKJOON_PROBLEM_NUMBER_MIN } from '../../constants.js';

// --------------------------------------------------------------------------------
// Typedefs
// --------------------------------------------------------------------------------

/**
 * @typedef {import('../../types.js').Problem} Problem
 * @typedef {import('superstruct').Struct<Problem>} ProblemStruct
 */

// --------------------------------------------------------------------------------
// Type Struct
// --------------------------------------------------------------------------------

/**
 * `Problem` type struct.
 *
 * @type {ProblemStruct}
 */
const Problem = refine(string(), 'Problem', problem =>
  Number(problem) >= BAEKJOON_PROBLEM_NUMBER_MIN
    ? true
    : `\`Problem\` must be Baekjoon problem number as a string. Problem number must be greater than or equal to \`${BAEKJOON_PROBLEM_NUMBER_MIN}\``,
);

// --------------------------------------------------------------------------------
// Export
// --------------------------------------------------------------------------------

export default Problem;