Skip to content

Commit

Permalink
💡 fix jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
nlepage committed Oct 30, 2017
1 parent 1267f96 commit b565081
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/core/toPath.js
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ const allowingArrays = fn => arg => {
/**
* Converts <code>str</code> to a path represented as an array of keys.
* @param {string} str The string to convert
* @return {(string|number)[]} The path represented as an array of keys
* @return {Array<string|number|Array>} The path represented as an array of keys
* @memberof core
* @private
* @since 0.4.0
Expand Down Expand Up @@ -244,7 +244,7 @@ const cache = new Map()
* Memoized version of {@link core.stringToPath}.<br />
* The cache has a maximum size of 1000, when overflowing the cache is cleared.
* @param {string} str The string to convert
* @return {(string|number)[]} The path represented as an array of keys
* @return {Array<string|number|Array>} The path represented as an array of keys
* @memberof core
* @private
* @since 0.4.0
Expand All @@ -267,7 +267,7 @@ const memoizedStringToPath = str => {
* If <code>arg</code> is neither a string nor an Array, its string representation will be parsed.<br />
* This function is failsafe, it will never throw an error.
* @param {string|Array|*} arg The value to convert
* @return {(string|number)[]} The path represented as an array of keys
* @return {Array<string|number|Array>} The path represented as an array of keys
* @memberof core
* @since 0.4.0
* @example toPath('a.b[1]["."][1:-1]') // => ['a', 'b', 1, '.', [1, -1]]
Expand All @@ -277,7 +277,7 @@ const toPath = allowingArrays(arg => [...memoizedStringToPath(arg)])
/**
* This method is like {@link core.toPath} except it returns memoized arrays which must not be mutated.
* @param {string|Array|*} arg The value to convert
* @return {(string|number)[]} The path represented as an array of keys
* @return {Array<string|number|Array>} The path represented as an array of keys
* @memberof core
* @since 0.4.0
* @private
Expand Down

0 comments on commit b565081

Please sign in to comment.