react-hook-form-rules 1.0.8 → 1.0.9

package/README.md

@@ -1,15 +1,29 @@
-## getRequiredRule
+# React-hook-form-rules
 
-### Description
+This is a small library that contains a few rules for clearer validation handling in the [react-hook-form](https://www.react-hook-form.com/) library.
+
+### Contacts
+
+Hello everyone 👋. 
+
+If you have any questions or suggestions, [my github profile](https://github.com/chopperqt). 
+
+
+
+## Rules
+
+### getRequiredRule
+
+#### Description
 This rule makes the field required.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | isRequired | boolean | true  |  |
 | message | string | "This field is required." |  . |
 
-### Code example
+#### Code example
 ```
 import { getRequiredRule } from 'react-hook-form-rules';
 
@@ -25,20 +39,20 @@ const {...} = useController({
 
 
 
-## getRequiredArrayRule
+### getRequiredArrayRule
 
-### Description
+#### Description
 This rule makes the array field required.
 
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | arr | array | []  |  |
 | message | string | "This field is required." |   |
 
 
-### Code example
+#### Code example
 ```
 import { getRequiredArrayRule } from 'react-hook-form-rules';
 
@@ -53,20 +67,20 @@ const {...} = useController({
 
 
 
-## getRequiredObjectRule
+### getRequiredObjectRule
 
-### Description
+#### Description
 This rule makes the object field required.
 
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | obj | object | {}  |  |
 | message | string | "This field is required." |   |
 
 
-### Code example
+#### Code example
 ```
 import { getRequiredObjectRule } from 'react-hook-form-rules';
 
@@ -80,18 +94,18 @@ const {...} = useController({
 
 
 
-## getMaxRule
+### getMaxRule
 
-### Description
+#### Description
 This rule returns an error if the number is greater than the specified value.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | max | number | -  | - |
 | message | string | - |  - |
 
-### Code example
+#### Code example
 ```
 import { getMaxRule } from 'react-hook-form-rules';
 
@@ -105,12 +119,12 @@ const {...} = useController({
 
 
 
-## getMaxLengthRule
+### getMaxLengthRule
 
-### Description
+#### Description
 This rule checks that the number of characters in the string does not exceed the specified value.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | maxLength | number | -  | - |
@@ -131,19 +145,19 @@ const {...} = useController({
 
 
 
-## getMaxArrayLengthRule
+### getMaxArrayLengthRule
 
-### Description
+#### Description
 This rule returns an error if the number of values in the array exceeds the specified limit.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | arr | arrray | -  | - |
 | maxLength | number | -  | - |
 | message | string | - |  - |
 
-### Code example
+#### Code example
 ```
 import { getMaxArrayLengthRule } from 'react-hook-form-rules';
 
@@ -156,18 +170,18 @@ const {...} = useController({
 
 
 
-## getMinRule
+### getMinRule
 
-### Description
+#### Description
 This rule checks that the string contains a minimum number of characters.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | min | number | -  | - |
 | message | string | - |  - |
 
-### Code example
+#### Code example
 ```
 import { getMinRule } from 'react-hook-form-rules';
 
@@ -181,18 +195,18 @@ const {...} = useController({
 
 
 
-## getMinLengthRule
+### getMinLengthRule
 
-### Description
+#### Description
 The rule checks that the string contains at least the specified number of characters.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | minLength | number | -  | - |
 | message | string | - |  - |
 
-### Code example
+#### Code example
 ```
 import { getMinLengthRule } from 'react-hook-form-rules';
 
@@ -206,19 +220,19 @@ const {...} = useController({
 
 
 
-## getMinArrayLengthRule
+### getMinArrayLengthRule
 
-### Description
+#### Description
 The rule checks that the array contains a minimum number of elements.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | arr | arrray | -  | - |
 | minLength | number | -  | - |
 | message | string | - |  - |
 
-### Code example
+#### Code example
 ```
 import { getMinArrayLengthRule } from 'react-hook-form-rules';
 
@@ -229,18 +243,18 @@ const {...} = useController({
 })
 ```
 
-## getEmailRule
+### getEmailRule
 
-### Description
+#### Description
 he rule checks the entered email for correctness.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | pattern | RegExp | -  | - |
 | message | string | - |  - |
 
-### Code example
+#### Code example
 ```
 import { getEmailRule } from 'react-hook-form-rules';
 
@@ -254,18 +268,18 @@ const {...} = useController({
 
 
 
-## getUrlRule
+### getUrlRule
 
-### Description
+#### Description
 The rule checks the entered URL for correctness.
 
-### Options
+#### Options
 | Option  | Type | Default | Description  |
 | -------- | --------- | ------ | ----------  |
 | pattern | RegExp | -  | - |
 | message | string | - |  - |
 
-### Code example
+#### Code example
 ```
 import { getUrlRule } from 'react-hook-form-rules';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-hook-form-rules",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",