postgresql-socket-url

Generates a well-formed URL for a given PostgreSQL domain socket path and database name. Useful when you want to use a database driver (like pg) to connect to PostgreSQL through a Unix domain socket.

Example

1"use strict";
2
3const postgresqlSocketUrl = require("postgresql-socket-url");
4
5let url = postgresqlSocketUrl({
6	socketPath: "/tmp",
7	database: "myproject"
8});
9
10console.log(url); // socket:/tmp?db=myproject

API

postgresqlSocketUrl(options)

Generates the URL to connect to.

• options:
  • socketPath: The path of the folder that contains the PostgreSQL socket. Not the path of the socket itself.
  • database: The name of the database to connect to.

Changelog

1.0.1 (September 14, 2019)

• Fixes validation logic to actually throw when the options are missing.

1.0.0 (September 14, 2019)

Initial release.