Skip to content

Commit 2c2c26e

Browse files
committed
sort-by options renamed to sortBy
1 parent fcc248e commit 2c2c26e

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ const jsdocParse = require('jsdoc-parse')
3030

3131
- jsdocData <code>Array.&lt;object&gt;</code> - jsdoc output
3232
- [options] <code>object</code>
33-
- [.sort-by] <code>string</code> | <code>Array.&lt;string&gt;</code> - Sort by one of more properties, e.g. `[ 'kind', 'category' ]`. Defaults to `[ 'scope', 'category', 'kind', 'order' ]`.
33+
- [.sortBy] <code>string</code> | <code>Array.&lt;string&gt;</code> - Sort by one of more properties, e.g. `[ 'kind', 'category' ]`. Defaults to `[ 'scope', 'category', 'kind', 'order' ]`.
3434

3535

3636
* * *

lib/jsdoc-parse.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ module.exports = jsdocParse
1111
/**
1212
* @param {object[]} - jsdoc output
1313
* @param [options] {object}
14-
* @param [options.sort-by] {string|string[]} - Sort by one of more properties, e.g. `[ 'kind', 'category' ]`. Defaults to `[ 'scope', 'category', 'kind', 'order' ]`.
14+
* @param [options.sortBy] {string|string[]} - Sort by one of more properties, e.g. `[ 'kind', 'category' ]`. Defaults to `[ 'scope', 'category', 'kind', 'order' ]`.
1515
* @returns {object[]}
1616
* @alias module:jsdoc-parse
1717
*/
@@ -20,7 +20,7 @@ function jsdocParse (jsdocData, options) {
2020
let data = transform(jsdocData)
2121

2222
/* sort */
23-
data = sort(data, options['sort-by'])
23+
data = sort(data, options.sortBy)
2424
return data
2525
}
2626

0 commit comments

Comments
 (0)