postgres-interval 3.0.0 → 4.0.0

package/index.d.ts

@@ -8,14 +8,79 @@ declare namespace PostgresInterval {
     seconds: number;
     milliseconds: number;
 
+    /**
+     * Returns an interval string. This allows the interval object to be passed into prepared statements.
+     *
+     * ```js
+     * var parse = require('postgres-interval')
+     * var interval = parse('01:02:03')
+     * // => { hours: 1, minutes: 2, seconds: 3 }
+     * interval.toPostgres()
+     * // 1 hour 2 minutes 3 seconds
+     * ```
+     */
     toPostgres(): string;
 
+    /**
+     * Returns an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) compliant string, for example P0Y0M0DT0H9M0S.
+     *
+     * Also available as {@link toISOString toISOString}.
+     *
+     * ```js
+     * var parse = require('postgres-interval')
+     * var interval = parse('01:02:03')
+     * // => { hours: 1, minutes: 2, seconds: 3 }
+     * interval.toISO()
+     * // P0Y0M0DT1H2M3S
+     * ```
+     */
     toISO(): string;
+    /**
+     * Returns an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) compliant string, for example P0Y0M0DT0H9M0S.
+     *
+     * Also available as {@link toISO toISO} for backwards compatibility.
+     *
+     * ```js
+     * var parse = require('postgres-interval')
+     * var interval = parse('01:02:03')
+     * // => { hours: 1, minutes: 2, seconds: 3 }
+     * interval.toISOString()
+     * // P0Y0M0DT1H2M3S
+     * ```
+     */
     toISOString(): string;
+    /**
+     * Returns an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) compliant string shortened to minimum length, for example `PT9M`.
+     *
+     * ```js
+     * var parse = require('postgres-interval')
+     * var interval = parse('01:02:03')
+     * // => { hours: 1, minutes: 2, seconds: 3 }
+     * interval.toISOStringShort()
+     * // PT1H2M3S
+     * ```
+     */
     toISOStringShort(): string;
   }
 }
 
+/**
+ * Parse Postgres interval columns.
+ *
+ * ```js
+ * var parse = require('postgres-interval')
+ * var interval = parse('01:02:03')
+ * // => { hours: 1, minutes: 2, seconds: 3 }
+ * interval.toPostgres()
+ * // 1 hour 2 minutes 3 seconds
+ * interval.toISOString()
+ * // P0Y0M0DT1H2M3S
+ * interval.toISOStringShort()
+ * // PT1H2M3S
+ * ```
+ *
+ * @param raw A Postgres interval string.
+ */
 declare function PostgresInterval(raw: string): PostgresInterval.IPostgresInterval;
 
 export = PostgresInterval;

package/index.js

@@ -9,12 +9,12 @@ function PostgresInterval (raw) {
 
   Object.assign(this, parse(raw))
 }
-const properties = ['seconds', 'minutes', 'hours', 'days', 'months', 'years']
+const properties = ['years', 'months', 'days', 'hours', 'minutes', 'seconds']
 PostgresInterval.prototype.toPostgres = function () {
   const filtered = properties.filter(key => Object.prototype.hasOwnProperty.call(this, key) && this[key] !== 0)
 
   // In addition to `properties`, we need to account for fractions of seconds.
-  if (this.milliseconds && filtered.indexOf('seconds') < 0) {
+  if (this.milliseconds && !filtered.includes('seconds')) {
     filtered.push('seconds')
   }
 
@@ -29,7 +29,10 @@ PostgresInterval.prototype.toPostgres = function () {
         value = (value + this.milliseconds / 1000).toFixed(6).replace(/\.?0+$/, '')
       }
 
-      return value + ' ' + property
+      // fractional seconds will be a String, all others are Number
+      const isSingular = String(value) === '1'
+      // Remove plural 's' when the value is singular
+      return value + ' ' + (isSingular ? property.replace(/s$/, '') : property)
     }, this)
     .join(' ')
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "postgres-interval",
   "main": "index.js",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "Parse Postgres interval columns",
   "license": "MIT",
   "repository": "bendrucker/postgres-interval",

package/readme.md

@@ -15,11 +15,13 @@ npm install --save postgres-interval
 ```js
 var parse = require('postgres-interval')
 var interval = parse('01:02:03')
-//=> {hours: 1, minutes: 2, seconds: 3}
+// => { hours: 1, minutes: 2, seconds: 3 }
 interval.toPostgres()
-// 3 seconds 2 minutes 1 hours
+// 1 hour 2 minutes 3 seconds
 interval.toISOString()
 // P0Y0M0DT1H2M3S
+interval.toISOStringShort()
+// PT1H2M3S
 ```
 
 This package parses the default Postgres interval style. If you have changed [`intervalstyle`](https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-INTERVALSTYLE), you will need to set it back to the default: