Update are_coprime.ts

TheAlgorithms · Sep 25, 2024 · 086a20e · 086a20e
1 parent b347325
commit 086a20e
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/maths/are_coprime.ts b/maths/are_coprime.ts
@@ -1,3 +1,12 @@
+/**
+ * @function areCoprime
+ * @description Checks if two given numbers are co-prime or not
+ * @param {a} number - a numeric input value
+ * @param {a} number - a numeric input value
+ * @example areCoprime(2,4) = false
+ * @example areCoprime(2,3) = true
+ */
+
 import { greatestCommonFactor } from "./greatest_common_factor"
 
 export const areCoprime = (a: number, b: number): boolean =>{