https://github.com/bendrucker/postgres-interval

Parse Postgres interval columns
https://github.com/bendrucker/postgres-interval

nodejs postgresql

Last synced: 22 days ago
JSON representation

Parse Postgres interval columns

• Host: GitHub
• URL: https://github.com/bendrucker/postgres-interval
• Owner: bendrucker
• License: mit
• Created: 2015-06-14T00:08:55.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-06-27T14:35:07.000Z (4 months ago)
• Last Synced: 2024-10-10T23:32:13.260Z (28 days ago)
• Topics: nodejs, postgresql
• Language: JavaScript
• Homepage:
• Size: 36.1 KB
• Stars: 32
• Watchers: 4
• Forks: 19
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# postgres-interval [![tests](https://github.com/bendrucker/postgres-interval/workflows/tests/badge.svg)](https://github.com/bendrucker/postgres-interval/actions?query=workflow%3Atests)

> Parse Postgres interval columns

## Install

```sh

npm install --save postgres-interval

```

## Usage

```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

```

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:

```sql

set intervalstyle to default;

```

## API

#### `parse(pgInterval)` -> `interval`

##### pgInterval

*Required*  

Type: `string`

A Postgres interval string.

This package is focused on parsing Postgres outputs. It optimizes for performance by assuming that inputs follow the default interval format. It does not perform any validation on the input. If any interval field is not found, its value will be set to `0` in the returned `interval`.

#### `interval.toPostgres()` -> `string`

Returns an interval string. This allows the interval object to be passed into prepared statements.

#### `interval.toISOString()` -> `string`

Returns an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) compliant string, for example `P0Y0M0DT0H9M0S`.

Also available as `interval.toISO()` for backwards compatibility.

#### `interval.toISOStringShort()` -> `string`

Returns an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) compliant string shortened to minimum length, for example `PT9M`.

## License

MIT © [Ben Drucker](http://bendrucker.me)