Added Declaration files

OmarWebDev · OmarWebDev · commit 0166f9de5643 · 2022-06-14T18:43:24.000+02:00
diff --git a/dist/index.html b/dist/index.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Title</title>
+  <script type="module" crossorigin src="/functionality.min.js"></script>
+</head>
+<body>
+
+
+
+</body>
+</html>
diff --git a/lib/array/filterArray.d.ts b/lib/array/filterArray.d.ts
@@ -0,0 +1,8 @@
+/**
+ * Filter an array depending on the given value
+ *
+ * @param {any[]} array
+ * @param {any} value
+ * @returns {any[]}
+ */
+export default function filterArray(array: any[], value: any): any[];
diff --git a/lib/array/getFactors.d.ts b/lib/array/getFactors.d.ts
@@ -0,0 +1,7 @@
+/**
+ * returns the factors of the given number
+ *
+ * @param {number} number
+ * @returns {number[]}
+ */
+export default function getFactors(number: number): number[];
diff --git a/lib/array/maxArray.d.ts b/lib/array/maxArray.d.ts
@@ -0,0 +1,7 @@
+/**
+ * Get maximum value in array
+ *
+ * @param {number[]} array
+ * @returns {number}
+ */
+export default function maxArray(array: number[]): number;
diff --git a/lib/array/minArray.d.ts b/lib/array/minArray.d.ts
@@ -0,0 +1,7 @@
+/**
+ * Get minimum value in array
+ *
+ * @param {number[]} array - Array of numbers
+ * @returns {number}
+ */
+export default function minArray(array: number[]): number;
diff --git a/lib/array/randomElementFrom.d.ts b/lib/array/randomElementFrom.d.ts
@@ -0,0 +1,7 @@
+/**
+ * Get a random element from an array
+ *
+ * @param {any[]} array
+ * @returns {any}
+ */
+export default function randomElementFrom(array: any[]): any;
diff --git a/lib/array/removeDuplicate.d.ts b/lib/array/removeDuplicate.d.ts
@@ -0,0 +1,7 @@
+/**
+ * Remove duplicated Elemets in array
+ *
+ * @param {any[]} array
+ * @returns {any[]}
+ */
+export default function removeDuplicate(array: any[]): void;
diff --git a/lib/array/shuffle.d.ts b/lib/array/shuffle.d.ts
@@ -0,0 +1,7 @@
+/**
+ * sort the array randomly
+ *
+ * @param {any[]} array array of anything
+ * @returns {array} sort of the array
+ */
+export default function shuffle(array: any[]): any[];
diff --git a/lib/array/sumOfArray.d.ts b/lib/array/sumOfArray.d.ts
@@ -0,0 +1,7 @@
+/**
+ * Get sum of all numbers in array
+ *
+ * @param {number[]} array array of numbers
+ * @returns {number} sum of all numbers in array
+ */
+export default function sumOfArray(array: number[]): number;
diff --git a/lib/colors/randomBoolean.d.ts b/lib/colors/randomBoolean.d.ts
@@ -0,0 +1,6 @@
+/**
+ * returns a random boolean (true or false)
+ *
+ * @returns {boolean}
+ */
+export default function randomBoolean(): boolean;
diff --git a/lib/colors/randomColor.d.ts b/lib/colors/randomColor.d.ts
@@ -0,0 +1,6 @@
+/**
+ * displays a random color
+ *
+ * @returns {string}
+ */
+export default function randomColor(): string;
diff --git a/lib/colors/randomHex.d.ts b/lib/colors/randomHex.d.ts
@@ -0,0 +1,6 @@
+/**
+ * returns a random hex color e.g #f35a00
+ *
+ * @returns {string}
+ */
+export default function randomHex(): string;
diff --git a/lib/colors/randomHsl.d.ts b/lib/colors/randomHsl.d.ts
@@ -0,0 +1,6 @@
+/**
+ * displays a random hsl color
+ *
+ * @returns {string}
+ */
+export default function randomHsl(): string;
diff --git a/lib/main.d.ts b/lib/main.d.ts
@@ -0,0 +1,56 @@
+import sumOfArray from "./array/sumOfArray";
+import capitalize from "./string/capitalize";
+import filterArray from "./array/filterArray";
+import getFactors from "./array/getFactors";
+import getMid from "./number/getMid";
+import isEven from "./number/isEven";
+import isOdd from "./number/isOdd";
+import isPrime from "./number/isPrime";
+import isPalindrome from "./string/isPalindrome";
+import maxArray from "./array/maxArray";
+import minArray from "./array/minArray";
+import randomBoolean from "./colors/randomBoolean";
+import randomElementFrom from "./array/randomElementFrom";
+import randomHex from "./colors/randomHex";
+import randomNumber from "./number/randomNumber";
+import removeDuplicate from "./array/removeDuplicate";
+import reverseString from "./string/reverseString";
+import reverseNumber from "./number/reverseNumber";
+import shuffle from "./array/shuffle";
+import randomString from "./string/randomString";
+import randomColor from "./colors/randomColor";
+import randomHsl from "./colors/randomHsl";
+import isHappyNumber from "./number/isHappyNumber";
+import randomPassword from "./string/randomPassword";
+declare const functionality: {
+    sumOfArray: typeof sumOfArray;
+    capitalize: typeof capitalize;
+    filterArray: typeof filterArray;
+    getFactors: typeof getFactors;
+    getMid: typeof getMid;
+    isEven: typeof isEven;
+    isOdd: typeof isOdd;
+    isPrime: typeof isPrime;
+    isPalindrome: typeof isPalindrome;
+    maxArray: typeof maxArray;
+    minArray: typeof minArray;
+    randomBoolean: typeof randomBoolean;
+    randomElementFrom: typeof randomElementFrom;
+    randomHex: typeof randomHex;
+    randomNumber: typeof randomNumber;
+    removeDuplicate: typeof removeDuplicate;
+    reverseString: typeof reverseString;
+    reverseNumber: typeof reverseNumber;
+    shuffle: typeof shuffle;
+    randomString: typeof randomString;
+    randomColor: typeof randomColor;
+    randomHsl: typeof randomHsl;
+    isHappyNumber: typeof isHappyNumber;
+    randomPassword: typeof randomPassword;
+};
+declare global {
+    interface Window {
+        functionality: typeof functionality;
+    }
+}
+export default functionality;
diff --git a/lib/number/getMid.d.ts b/lib/number/getMid.d.ts
@@ -0,0 +1,8 @@
+/**
+ * get average between two numbers
+ *
+ * @param {number} number1
+ * @param {number} number2
+ * @returns {number}
+ */
+export default function getMid(number1: number, number2: number): number;
diff --git a/lib/number/isEven.d.ts b/lib/number/isEven.d.ts
@@ -0,0 +1,7 @@
+/**
+ * check if a number is even
+ *
+ * @param {number} number
+ * @returns {boolean}
+ */
+export default function isEven(number: number): boolean;
diff --git a/lib/number/isHappyNumber.d.ts b/lib/number/isHappyNumber.d.ts
@@ -0,0 +1,7 @@
+/**
+ * displays if  number is happy number or not
+ *
+ * @param {number} n
+ * @returns {boolean}
+ */
+export default function isHappyNumber(n: number): boolean;
diff --git a/lib/number/isOdd.d.ts b/lib/number/isOdd.d.ts
@@ -0,0 +1,7 @@
+/**
+ * check if a number is odd
+ *
+ * @param {number} number
+ * @returns {boolean}
+ */
+export default function isOdd(number: number): boolean;
diff --git a/lib/number/isPrime.d.ts b/lib/number/isPrime.d.ts
@@ -0,0 +1,7 @@
+/**
+ * check if a number is prime
+ *
+ * @param {number} number
+ * @returns {boolean}
+ */
+export default function isPrime(number: number): boolean;
diff --git a/lib/number/randomNumber.d.ts b/lib/number/randomNumber.d.ts
@@ -0,0 +1,8 @@
+/**
+ * Generate a random number
+ *
+ * @param {number} min
+ * @param {number} max
+ * @returns {number}
+ */
+export default function randomNumber(min: number, max: number): number;
diff --git a/lib/number/reverseNumber.d.ts b/lib/number/reverseNumber.d.ts
@@ -0,0 +1,7 @@
+/**
+ * reverse a number (e.g. 12345 -> 54321 or -12345 -> -54321)
+ *
+ * @param {number} number
+ * @returns {number}
+ */
+export default function reverseNumber(number: number): number;
diff --git a/lib/string/capitalize.d.ts b/lib/string/capitalize.d.ts
@@ -0,0 +1,7 @@
+/**
+ * Making first letter capital in the word
+ *
+ * @param {string} word
+ * @returns {string}
+ */
+export default function capitalize(word: string): string;
diff --git a/lib/string/isPalindrome.d.ts b/lib/string/isPalindrome.d.ts
@@ -0,0 +1,7 @@
+/**
+ * check if a string is a palindrome
+ *
+ * @param {string} word
+ * @returns {boolean}
+ */
+export default function isPalindrome(word: string): boolean;
diff --git a/lib/string/randomPassword.d.ts b/lib/string/randomPassword.d.ts
@@ -0,0 +1,6 @@
+/**
+ * generates a strong password
+ *
+ * @returns {string}
+ */
+export default function randomPassword(): string;
diff --git a/lib/string/randomString.d.ts b/lib/string/randomString.d.ts
@@ -0,0 +1,7 @@
+/**
+ * Generate a random String
+ *
+ * @param {number} length
+ * @returns {string}
+ */
+export default function randomString(length?: number): string;
diff --git a/lib/string/reverseString.d.ts b/lib/string/reverseString.d.ts
@@ -0,0 +1,6 @@
+/**
+ *
+ * @param {string} word
+ * @returns {string}
+ */
+export default function reverseString(word: string): string;
