Itee-Validators

Source: sources/physics/temperatures/isCelsius.js

/**
 * @author [Tristan Valcke]{@link https://github.com/Itee}
 * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
 *
 * @module sources/physics/temperatures
 * @desc Export function to validate if a value is a Celsius temperature
 * @example
 *
 * import { isCelsius } from 'itee-validators'
 *
 * if( isCelsius( value ) ) {
 *     //...
 * } else {
 *     //...
 * }
 *
 */

import { isNumber }              from '../../cores/numbers/isNumber'
import { ABSOLUTE_ZERO_CELSIUS } from './constants'

/**
 *
 * @param data {*}
 * @return {boolean}
 */
export function isCelsius( data ) {
    return ( isNumber( data ) && data >= ABSOLUTE_ZERO_CELSIUS )
}

/**
 *
 * @param data {*}
 * @return {boolean}
 */
export function isNotCelsius( data ) {
    return !isCelsius( data )
}