update deps and readme

Author: 75lb

README.hbs

@@ -18,7 +18,9 @@ Some trivial examples to demonstrate typical usage.
 
 ### Sorting an array of primitives
 
-Sort an array of strings.
+#### Ascending order
+
+Sort an array of strings in ascending order (the default).
 
 ```js
 > const partsOfTheDay = ['twilight', 'afternoon', 'morning', 'evening']
@@ -27,9 +29,18 @@ Sort an array of strings.
 [ 'afternoon', 'evening', 'morning', 'twilight' ]
 ```
 
+#### Descending order
+
+Sort an array of strings in descending order.
+
+```js
+> sortArray(partsOfTheDay, { order: 'desc' })
+[ 'twilight', 'morning', 'evening', 'afternoon' ]
+```
+
 #### Custom sort order
 
-The default sort order is `asc`. You can also specify `desc` or the name of a property from the `customOrders` object. For example, sort parts of the day by the order in which they occur.
+The default value for `options.order` is `'asc'`. You can also specify `'desc'` or the name of a property from the `customOrders` object. For example, sort parts of the day by the order in which they occur.
 
 ```js
 > sortArray(partsOfTheDay, {
@@ -43,6 +54,28 @@ The default sort order is `asc`. You can also specify `desc` or the name of a pr
 
 ### Sorting an array of objects
 
+#### Sort by object property
+
+Pass one or more property names to `options.by` to sort an array of objects by those properties.
+
+```js
+> const repositories = [
+  { name: '75lb/sort-array', openIssues: 0, closedIssues: 4 },
+  { name: 'lwsjs/local-web-server', openIssues: 4, closedIssues: 80 },
+  { name: 'jsdoc2md/jsdoc-api', openIssues: 3, closedIssues: 47 }
+]
+
+> sortArray(repositories, {
+  by: 'openIssues',
+  order: 'desc'
+})
+[
+  { name: 'lwsjs/local-web-server', openIssues: 4, closedIssues: 80 },
+  { name: 'jsdoc2md/jsdoc-api', openIssues: 3, closedIssues: 47 },
+  { name: '75lb/sort-array', openIssues: 0, closedIssues: 4 }
+]
+```
+
 #### Sort by computed field
 
 Sort by a computed field, i.e. a computed value that doesn't exist in the input dataset. Define your computed fields in the `options.computed` object, each value being a function which takes an array member as input and returns the primitive value to be sorted by. In this example we sort by `total` (the name of the computed field supplied in `options.computed`).

README.md

@@ -18,7 +18,9 @@ Some trivial examples to demonstrate typical usage.
 
 ### Sorting an array of primitives
 
-Sort an array of strings.
+#### Ascending order
+
+Sort an array of strings in ascending order (the default).
 
 ```js
 > const partsOfTheDay = ['twilight', 'afternoon', 'morning', 'evening']
@@ -27,9 +29,18 @@ Sort an array of strings.
 [ 'afternoon', 'evening', 'morning', 'twilight' ]
 ```
 
+#### Descending order
+
+Sort an array of strings in descending order.
+
+```js
+> sortArray(partsOfTheDay, { order: 'desc' })
+[ 'twilight', 'morning', 'evening', 'afternoon' ]
+```
+
 #### Custom sort order
 
-The default sort order is `asc`. You can also specify `desc` or the name of a property from the `customOrders` object. For example, sort parts of the day by the order in which they occur.
+The default value for `options.order` is `'asc'`. You can also specify `'desc'` or the name of a property from the `customOrders` object. For example, sort parts of the day by the order in which they occur.
 
 ```js
 > sortArray(partsOfTheDay, {
@@ -43,6 +54,28 @@ The default sort order is `asc`. You can also specify `desc` or the name of a pr
 
 ### Sorting an array of objects
 
+#### Sort by object property
+
+Pass one or more property names to `options.by` to sort an array of objects by those properties.
+
+```js
+> const repositories = [
+  { name: '75lb/sort-array', openIssues: 0, closedIssues: 4 },
+  { name: 'lwsjs/local-web-server', openIssues: 4, closedIssues: 80 },
+  { name: 'jsdoc2md/jsdoc-api', openIssues: 3, closedIssues: 47 }
+]
+
+> sortArray(repositories, {
+  by: 'openIssues',
+  order: 'desc'
+})
+[
+  { name: 'lwsjs/local-web-server', openIssues: 4, closedIssues: 80 },
+  { name: 'jsdoc2md/jsdoc-api', openIssues: 3, closedIssues: 47 },
+  { name: '75lb/sort-array', openIssues: 0, closedIssues: 4 }
+]
+```
+
 #### Sort by computed field
 
 Sort by a computed field, i.e. a computed value that doesn't exist in the input dataset. Define your computed fields in the `options.computed` object, each value being a function which takes an array member as input and returns the primitive value to be sorted by. In this example we sort by `total` (the name of the computed field supplied in `options.computed`).
@@ -154,7 +187,7 @@ const sortArray = require('sort-array')
 | array | <code>Array</code> | The input array to sort. It is sorted in place. |
 | [options] | <code>object</code> | Sort options. |
 | [options.by] | <code>Array.&lt;string&gt;</code> | One or more property names or computed fields to sort by. Specifying property names is only relevant when sorting an array of objects. |
-| [options.order] | <code>Array.&lt;string&gt;</code> | One or more sort orders. Specify `asc`, `desc` or a property name from the `options.customOrders` object. |
+| [options.order] | <code>Array.&lt;string&gt;</code> | One or more sort orders. Specify `'asc'`, `'desc'` or a property name from the `options.customOrders` object. |
 | [options.customOrders] | <code>object</code> | A dictionary object containing one or more custom orders. Each custom order value must be an array defining the order expected values must be sorted in. |
 | [options.computed] | <code>object</code> | A dictionary object containing one or more computed field functions. The function will be invoked once per item in the array. Each invocation will receive the array item as input and must return a primitive value by which the array can be sorted. |
 | [options.nullRank] | <code>number</code> | Configures whether `null` values will be sorted before or after defined values. Set to `-1` for before, `1` for after. Defaults to `1`. |

dist/index.js

@@ -348,9 +348,11 @@
    * @param {Array} array - The input array to sort. It is sorted in place.
    * @param {object} [options] - Sort options.
    * @param {string[]} [options.by] - One or more property names or computed fields to sort by. Specifying property names is only relevant when sorting an array of objects.
-   * @param {string[]} [options.order] - One or more sort orders. Specify `asc`, `desc` or a property name from the `options.customOrders` object.
+   * @param {string[]} [options.order] - One or more sort orders. Specify `'asc'`, `'desc'` or a property name from the `options.customOrders` object.
    * @param {object} [options.customOrders] - A dictionary object containing one or more custom orders. Each custom order value must be an array defining the order expected values must be sorted in.
    * @param {object} [options.computed] - A dictionary object containing one or more computed field functions. The function will be invoked once per item in the array. Each invocation will receive the array item as input and must return a primitive value by which the array can be sorted.
+   * @param {number} [options.nullRank] - Configures whether `null` values will be sorted before or after defined values. Set to `-1` for before, `1` for after. Defaults to `1`.
+   * @param {number} [options.undefinedRank] - Configures whether `undefined` values will be sorted before or after defined values. Set to `-1` for before, `1` for after. Defaults to `1`.
    * @returns {Array} Returns the array that was passed in.
    * @alias module:sort-array
    */

dist/index.mjs

@@ -342,9 +342,11 @@ var t = {
  * @param {Array} array - The input array to sort. It is sorted in place.
  * @param {object} [options] - Sort options.
  * @param {string[]} [options.by] - One or more property names or computed fields to sort by. Specifying property names is only relevant when sorting an array of objects.
- * @param {string[]} [options.order] - One or more sort orders. Specify `asc`, `desc` or a property name from the `options.customOrders` object.
+ * @param {string[]} [options.order] - One or more sort orders. Specify `'asc'`, `'desc'` or a property name from the `options.customOrders` object.
  * @param {object} [options.customOrders] - A dictionary object containing one or more custom orders. Each custom order value must be an array defining the order expected values must be sorted in.
  * @param {object} [options.computed] - A dictionary object containing one or more computed field functions. The function will be invoked once per item in the array. Each invocation will receive the array item as input and must return a primitive value by which the array can be sorted.
+ * @param {number} [options.nullRank] - Configures whether `null` values will be sorted before or after defined values. Set to `-1` for before, `1` for after. Defaults to `1`.
+ * @param {number} [options.undefinedRank] - Configures whether `undefined` values will be sorted before or after defined values. Set to `-1` for before, `1` for after. Defaults to `1`.
  * @returns {Array} Returns the array that was passed in.
  * @alias module:sort-array
  */

index.mjs

@@ -14,7 +14,7 @@ import t from 'typical/index.mjs'
  * @param {Array} array - The input array to sort. It is sorted in place.
  * @param {object} [options] - Sort options.
  * @param {string[]} [options.by] - One or more property names or computed fields to sort by. Specifying property names is only relevant when sorting an array of objects.
- * @param {string[]} [options.order] - One or more sort orders. Specify `asc`, `desc` or a property name from the `options.customOrders` object.
+ * @param {string[]} [options.order] - One or more sort orders. Specify `'asc'`, `'desc'` or a property name from the `options.customOrders` object.
  * @param {object} [options.customOrders] - A dictionary object containing one or more custom orders. Each custom order value must be an array defining the order expected values must be sorted in.
  * @param {object} [options.computed] - A dictionary object containing one or more computed field functions. The function will be invoked once per item in the array. Each invocation will receive the array item as input and must return a primitive value by which the array can be sorted.
  * @param {number} [options.nullRank] - Configures whether `null` values will be sorted before or after defined values. Set to `-1` for before, `1` for after. Defaults to `1`.

package-lock.json

@@ -34,11 +34,11 @@
     "typical": "^6.0.0"
   },
   "devDependencies": {
-    "@test-runner/web": "^0.3.3",
+    "@test-runner/web": "^0.3.4",
     "esm-runner": "^0.3.4",
     "isomorphic-assert": "^0.1.1",
     "jsdoc-to-markdown": "^5.0.3",
-    "rollup": "^1.27.10",
+    "rollup": "^1.31.0",
     "rollup-plugin-node-resolve": "^5.2.0",
     "test-object-model": "^0.6.1"
   },