styled-breakpoints/shared/create-invariant/index.js

Simple and powerful css breakpoints for styled-components and emotion

// @ts-check

const DEFAULT_PREFIX = '[prefix]: ';
const DEFAULT_MESSAGE = 'Invariant failed';

/**
 * Creates an invariant function that raises an error when a condition is not met.
 *
 * @param {string} [errorPrefix='[prefix]: '] - The prefix to add to the error message.
 * @returns {(condition: boolean, message?: string) => void} - An invariant function.
 */
const createInvariant =
  (errorPrefix = DEFAULT_PREFIX) =>
  /**
   * Throws an error if the provided condition is false.
   *
   * @param {boolean} condition - The condition to check.
   * @param {string} [message='Invariant failed'] - The error message to display if the condition is false.
   * @throws {Error} If the condition is false.
   */
  (condition, message = DEFAULT_MESSAGE) => {
    if (!condition) {
      throw new Error(errorPrefix + message);
    }
  };

module.exports = {
  DEFAULT_PREFIX,
  DEFAULT_MESSAGE,
  createInvariant,
};