From 54c204441629b65754dade6cb58a443566fefb22 Mon Sep 17 00:00:00 2001 From: Attila Olah Date: Thu, 27 Apr 2017 12:41:30 +0200 Subject: [PATCH] feat: add basic typings To make this app consumable by Typescript apps a typings file must be present. --- index.d.ts | 14 ++++++++++++++ package.json | 3 ++- 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 index.d.ts diff --git a/index.d.ts b/index.d.ts new file mode 100644 index 00000000..55637511 --- /dev/null +++ b/index.d.ts @@ -0,0 +1,14 @@ +export function parse(connectionString: string): ConnectionOptions; + +export interface ConnectionOptions { + host: string | null; + password: string | null; + user: string | null; + port: number | null; + database: string | null; + client_encoding: string | null; + ssl: boolean | null; + + application_name: string | null; + fallback_application_name: string | null; +} diff --git a/package.json b/package.json index c6d4512d..f3b14c90 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,8 @@ "name": "pg-connection-string", "version": "0.1.3", "description": "Functions for dealing with a PostgresSQL connection string", - "main": "index.js", + "main": "./index.js", + "types": "./index.d.ts", "scripts": { "test": "tap ./test" },