-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
UI-943: Add documentation for the getFormData() method
- Loading branch information
1 parent
6b93874
commit 6b71724
Showing
2 changed files
with
24 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# [monster][monster].[ui][ui].getFormData() | ||
|
||
* [Syntax](#syntax) | ||
* [Parameters](#parameters) | ||
* [Description](#description) | ||
|
||
### Syntax | ||
```javascript | ||
monster.ui.getFormData(rootNode[, delimiter, skipEmpty, nodeCallback, useIdIfEmptyName]); | ||
``` | ||
|
||
### Parameters | ||
The parameters are the same than the [form2js][form2js] function. | ||
|
||
### Description | ||
This method is a wrapper of the form2js function. Its goal is to clean the object returned by form2js of all empty keys when the form passed as a parameter contains inputs without a `name` parameter. | ||
|
||
[monster]: ../../monster.md | ||
[ui]: ../ui.md | ||
|
||
[form2js]: https://github.com/maxatwork/form2js#form2js |