Port missing in 'ConnectionConfig' TypeScript definition?

[timorthi]

Environment

Knex version: 0.18.4
Database + version: Postgres 9.5
OS: macOS 10.14

If issue is about TypeScript definitions, tag @lorefnon.

Bug

(I'm opening this issue under the assumption that I'm supposed to use 'ConnectionConfig' to type my PG connection config object. If my assumption is wrong, then there seems to be a missing type definition for Postgres connection config?)

---

The pg library accepts a port key, and passing the port key to knex indeed works:

import Knex from 'knex';

// TS compiler complaining about 'port' not being in the type definition
const pgConnectionConfig: Knex.ConnectionConfig = {
    port: 1234,
    host: 'myhost'
    user: 'myuser'
    password: 'mypw'
    database: 'mydb'
};

// Attempts to connect to 'myhost' on port 1234
const k = Knex({
  client: 'pg',
  connection: pgConnectionConfig,
  ...
});

but this key is missing in the ConnectionConfig interface.

[kibertoad]

Could you create a pr with the fix?

[kibertoad]

isn't there separate interface for pg config in master, though?

[timorthi]

@kibertoad Sure! As for the config interfaces, I only see these: ConnectionConfig | MariaSqlConnectionConfig | MySqlConnectionConfig | MsSqlConnectionConfig | OracleDbConnectionConfig | Sqlite3ConnectionConfig | SocketConnectionConfig (link).

There isn't an interface called PgConnectionConfig or something similar, which is why I assumed ConnectionConfig to be the "PG interface". Should that be renamed to PgConnectionConfig?

[timorthi]

@kibertoad Just submitted a PR for a separate PgConnectionConfig interface -- I'm still unsure about what driver ConnectionConfig is meant for...

[kibertoad]

Released in 0.20.1