@technobuddha/library/dist/is-multiple-of.js

A large library of useful functions

import { isNumber } from "./is-number.js";
/**
 * Tests to see if the specified value is an multiple of *multiplier*
 * @param input - The number to test
 * @param multiplier - The multiplier
 * @returns true, if the number is a multiple
 * @example
 * ```typescript
 * isMultipleOf(6, 3); // true
 * isMultipleOf(7, 3); // false
 * isMultipleOf(0, 5); // true
 * isMultipleOf(10, 2); // true
 * isMultipleOf(10, 0); // false
 * isMultipleOf(0, 0); // true
 * ```
 * @group Math
 * @category Comparison
 */
export function isMultipleOf(input, multiplier) {
    return isNumber(input) && (input % multiplier === 0 || (input === 0 && multiplier === 0));
}
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaXMtbXVsdGlwbGUtb2YuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaXMtbXVsdGlwbGUtb2YudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFFBQVEsRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBRTFDOzs7Ozs7Ozs7Ozs7Ozs7O0dBZ0JHO0FBQ0gsTUFBTSxVQUFVLFlBQVksQ0FBQyxLQUFhLEVBQUUsVUFBa0I7SUFDNUQsT0FBTyxRQUFRLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxLQUFLLEdBQUcsVUFBVSxLQUFLLENBQUMsSUFBSSxDQUFDLEtBQUssS0FBSyxDQUFDLElBQUksVUFBVSxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7QUFDNUYsQ0FBQyJ9