Add some js Doc for helper #1100
Merged
Conversation
This file contains hidden or 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
ktsn
requested changes
Jan 3, 2018
src/helpers.js
Outdated
| @@ -1,3 +1,9 @@ | |||
| /** | |||
| * Reduce the code which written in Vue.js for getting the state. | |||
| * @param {String} namepsace | |||
There was a problem hiding this comment.
Since namespace is an optional parameter, it should be @param {String} [namespace]. (same for other helpers)
http://usejsdoc.org/tags-param.html#optional-parameters-and-default-values
src/helpers.js
Outdated
| @@ -1,3 +1,9 @@ | |||
| /** | |||
| * Reduce the code which written in Vue.js for getting the state. | |||
| * @param {String} namepsace | |||
src/helpers.js
Outdated
| function normalizeMap (map) { | ||
| return Array.isArray(map) | ||
| ? map.map(key => ({ key, val: key })) | ||
| : Object.keys(map).map(key => ({ key, val: map[key] })) | ||
| } | ||
|
|
||
| /** | ||
| * Return a function expect two param contains namepsace and map. it will normalize the namespace and then the param's function will handle the new namespace and the map. |
src/helpers.js
Outdated
| @@ -22,10 +28,17 @@ export const mapState = normalizeNamespace((namespace, states) => { | |||
| return res | |||
| }) | |||
|
|
|||
| /** | |||
| * Reduce the code which written in Vue.js for committing the mutation | |||
| * @param {String} namepsace | |||
src/helpers.js
Outdated
| * Search a special module from store by namespace. if module not exist, print error message. | ||
| * @param {Object} store | ||
| * @param {String} helper | ||
| * @param {String} namepsace |
lanzhiheng
changed the title
|
@ktsn Thank you for your comments, I will fix them and remove the WIP. 😄 |
lanzhiheng
changed the title
|
@ktsn Hi, I have fixed all PR by you feedback 😸 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.