Document index.js

index.js

@@ -1,5 +1,16 @@
 
 
+/**
+ * Given an expiration date, filter dates that are
+ * valid, expired or expire soon.
+ *
+ * @param {Array} arr
+ * @param {Number|Date|String} limit
+ * @param {Number} soon
+ * @return {Object}
+ * @api public
+ */
+
 module.exports = (arr, limit, soon = 0) => {
   const obj = { valid: [], expired: [], soon: []}
   limit = parse(limit)
@@ -17,6 +28,14 @@ module.exports = (arr, limit, soon = 0) => {
 }
 
 
+/**
+ * Parse given time into a date in ms.
+ *
+ * @param {Date|Number|String} time
+ * @return {Number}
+ * @api private
+ */
+
 function parse (time) {
   return typeof time === 'number' ? time : Date.parse(time)
 }

test/runout.js

@@ -6,7 +6,7 @@ const test = require('tape')
 const runout = require('..')
 
 
-test('should extract valid and expired dates from a given expiration limit', assert => {
+test('should filter valid and expired dates from a given expiration limit', assert => {
   assert.plan(1)
   const obj = runout([
     new Date('01-01-2000').getTime(),
@@ -51,7 +51,7 @@ test('should convert date strings into ms and sort them', assert => {
 })
 
 
-test('should extract dates that expire soon', assert => {
+test('should filter dates that expire soon', assert => {
   assert.plan(1)
   const obj = runout([
     new Date('01-01-2000'),