Skip to content

Commit 372e77b

Browse files
committed
release v1.0.3
1 parent dc36959 commit 372e77b

File tree

3 files changed

+15
-14
lines changed

3 files changed

+15
-14
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,17 @@
55

66
Vue composition function for form validation. The word _validierung_ is the german translation for validation.
77

8-
- 🌌 Written in TypeScript
9-
- ☄️ Asynchronous rules
10-
- 🌊 Dynamic forms
11-
- 🌳 [Vue 2.7](https://v2.vuejs.org/) and [Vue 3](https://vuejs.org/)
8+
- 🌌 **Written in TypeScript**
9+
- ☄️ **Asynchronous rules**
10+
- 🌊 **Dynamic forms**
11+
- 🌳 **[Vue 2.7](https://v2.vuejs.org/) and [Vue 3](https://vuejs.org/)**
1212

1313
```bash
1414
npm install validierung
1515
```
1616

17-
- [**Documentation**](https://github.com/JensDll/validierung/wiki/Documentation)
18-
- [**Vue 2 Example**](https://stackblitz.com/github/JensDll/validierung/tree/main/playground/vue2?file=src%2Fmain.ts)
19-
- [**Vue 3 Example**](https://stackblitz.com/github/JensDll/validierung/tree/main/playground/vue3?file=src%2Fmain.ts)
17+
[**:arrow_right: Documentation**](https://github.com/JensDll/validierung/wiki/Documentation)
18+
19+
[**:arrow_right: Vue 2 Example**](https://stackblitz.com/github/JensDll/validierung/tree/main/playground/vue2?file=src%2Fmain.ts)
20+
21+
[**:arrow_right: Vue 3 Example**](https://stackblitz.com/github/JensDll/validierung/tree/main/playground/vue3?file=src%2Fmain.ts)

packages/validierung/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "validierung",
3-
"version": "1.0.2",
3+
"version": "1.0.3",
44
"description": "Vue composition function for form validation",
55
"license": "MIT",
66
"author": {

packages/validierung/src/useValidation.ts

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -200,11 +200,10 @@ export type UseValidation<FormData extends object> = {
200200
*/
201201
resetFields(formData?: DeepPartial<ResultFormData<FormData>>): void
202202
/**
203-
* Adds a new property to the form data.
204-
* Fields with a `$value` property are transformed.
203+
* Adds a new value to the form data.
205204
*
206-
* @param path - A path of `string` and `numbers`
207-
* @param value - The value to add at the specified path
205+
* @param path - A path for the new value
206+
* @param value - The value to add
208207
*/
209208
add<Keys extends readonly (string | number)[]>(
210209
path: readonly [...Keys],
@@ -213,9 +212,9 @@ export type UseValidation<FormData extends object> = {
213212
: DeepIndex<FormData, Keys>
214213
): void
215214
/**
216-
* Removes a property from the form data.
215+
* Removes a value from the form data.
217216
*
218-
* @param path - A path of `string` and `numbers` to the property to remove
217+
* @param path - A path to the value to remove
219218
*/
220219
remove(path: (string | number)[]): void
221220
}

0 commit comments

Comments
 (0)