Add getEnumValues (#11)

Author: henriqueleite42

CHANGELOG.md

@@ -13,6 +13,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+## [1.1.0] - 2021-10-17
+
+### Added
+
+- `getEnumValues`
+
+### Changed
+
+### Removed
+
+## [1.0.3] - 2021-10-17
+
+### Added
+
+### Changed
+
+- `getTypeof` returns `function` for javascript functions, like `Date`, `String`, `Object`, etc
+
+### Removed
+
 ## [1.0.2] - 2021-10-16
 
 ### Added

README.md

@@ -14,7 +14,7 @@
 	<img src="https://img.shields.io/coveralls/github/techmmunity/utils/master?style=for-the-badge" alt="Coveralls">
 </a>
 <a href="https://github.com/techmmunity/utils/actions/workflows/coverage.yml">
-	<img src="https://img.shields.io/github/workflow/status/techmmunity/utils/tests?label=tests&logo=github&style=for-the-badge" alt="Tests">
+	<img src="https://img.shields.io/github/workflow/status/techmmunity/utils/Collect%20Coverage?label=tests&logo=github&style=for-the-badge" alt="Tests">
 </a>
 <a href="https://www.npmjs.com/package/@techmmunity/utils">
 	<img src="https://img.shields.io/npm/v/@techmmunity/utils.svg?color=CC3534&style=for-the-badge" alt="Npm">
@@ -30,17 +30,6 @@
 
 Package of utils, make in a way to let you import only the functions that you really need, so it doesn't make your project heavier than it needs to be.
 
-| function               | description                                                            |
-| ---------------------- | ---------------------------------------------------------------------- |
-| `cleanObj`             | Remove undefined and null values from an object                        |
-| `getArrayUniqueValues` | Remove duplicated values of an array (only work with primitive values) |
-| `getTypeof`            | Fix native "typeof"                                                    |
-| `hasRequiredEnvVars`   | Verify if all env vars are defined                                     |
-| `isEmptyArray`         | Checks if is an array and it's empty                                   |
-| `isEmptyObject`        | Checks if is an object and it's empty                                  |
-| `isNotEmptyArray`      | Checks if is an array and it's NOT empty                               |
-| `isNotEmptyObject`     | Checks if is an object and it's NOT empty                              |
-
 ## Install
 
 With Yarn:
@@ -55,8 +44,16 @@ With NPM:
 npm i @techmmunity/utils
 ```
 
-## How to contribute?
+# Docs
 
-All the details about contributing to the project are [described here](https://github.com/techmmunity/utils/blob/master/CONTRIBUTING.md).
-
-## Documentation
+| function               | description                                                            |
+| ---------------------- | ---------------------------------------------------------------------- |
+| `cleanObj`             | Remove undefined and null values from an object                        |
+| `getArrayUniqueValues` | Remove duplicated values of an array (only work with primitive values) |
+| `getEnumValues`        | Return the enum values                                                 |
+| `getTypeof`            | Fix native "typeof"                                                    |
+| `hasRequiredEnvVars`   | Verify if all env vars are defined                                     |
+| `isEmptyArray`         | Checks if is an array and it's empty                                   |
+| `isEmptyObject`        | Checks if is an object and it's empty                                  |
+| `isNotEmptyArray`      | Checks if is an array and it's NOT empty                               |
+| `isNotEmptyObject`     | Checks if is an object and it's NOT empty                              |

jest.config.js

@@ -15,10 +15,10 @@ module.exports = {
 	resetMocks: true,
 	coverageThreshold: {
 		global: {
-			statements: 96.07,
+			statements: 96.29,
 			branches: 92.85,
 			functions: 100,
-			lines: 97.5,
+			lines: 97.61,
 		},
 	},
 };

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@techmmunity/utils",
-	"version": "1.0.3",
+	"version": "1.1.0",
 	"main": "index.js",
 	"types": "index.d.ts",
 	"license": "Apache-2.0",
@@ -21,6 +21,7 @@
 		"array",
 		"lodash",
 		"ramda",
+		"get-enum-values",
 		"empty-array",
 		"empty-object"
 	],

src/index.ts

@@ -18,6 +18,7 @@ export * from "./lib/clean-obj";
 
 export * from "./lib/get-typeof";
 export * from "./lib/get-array-unique-values";
+export * from "./lib/get-enum-values";
 
 /**
  * ---------------------------------------------------------------------------

src/lib/get-enum-values/index.ts

@@ -0,0 +1,2 @@
+export const getEnumValues = <T>(ENUM: any) =>
+	[...new Set(Object.values(ENUM))] as Array<T>;

src/tests/get-enum-values.spec.ts

@@ -0,0 +1,41 @@
+import { getEnumValues } from "lib/get-enum-values";
+
+describe("getEnumValues Util", () => {
+	describe("With enum that key-value match", () => {
+		it("should return the enum values", () => {
+			let result: any;
+
+			try {
+				enum TestEnum {
+					FOO = "FOO",
+					BAR = "BAR",
+				}
+
+				result = getEnumValues<TestEnum>(TestEnum);
+			} catch (err: any) {
+				result = err;
+			}
+
+			expect(result).toStrictEqual(["FOO", "BAR"]);
+		});
+	});
+
+	describe("With enum that key-value DON'T match", () => {
+		it("should return the enum values", () => {
+			let result: any;
+
+			try {
+				enum TestEnum {
+					FOO = "FOO1",
+					BAR = "BAR1",
+				}
+
+				result = getEnumValues<TestEnum>(TestEnum);
+			} catch (err: any) {
+				result = err;
+			}
+
+			expect(result).toStrictEqual(["FOO1", "BAR1"]);
+		});
+	});
+});