Deprecate equal validation in favor of value #192

fabian-hiller · Oct 8, 2023 · 982045e · 982045e
1 parent 75ae6a4
commit 982045e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/library/CHANGELOG.md b/library/CHANGELOG.md
@@ -7,6 +7,7 @@ All notable changes to the library will be documented in this file.
 - Add `notBytes`, `notLength`, `notSize` and `notValue` validation function (pull request #194)
 - Change regex of `email` validation (pull request #180)
 - Fix types at `brand`, `transform` and `unwrap` method (issue #195)
+- Deprecate `equal` validation function in favor of `value` (issue #192)
 
 ## v0.18.0 (September 30, 2023)
 

diff --git a/library/src/validations/equal/equal.ts b/library/src/validations/equal/equal.ts
@@ -4,6 +4,8 @@ import { getOutput, getPipeIssues } from '../../utils/index.ts';
 /**
  * Creates a validation function that checks the value for equality.
  *
+ * @deprecated Function has been renamed to `value`.
+ *
  * @param requirement The required value.
  * @param error The error message.
  *