No Description

Sven Slootweg 67e28e9071 Initial commit 11 months ago
.gitignore 67e28e9071 Initial commit 11 months ago
README.md 67e28e9071 Initial commit 11 months ago
example.js 67e28e9071 Initial commit 11 months ago
index.js 67e28e9071 Initial commit 11 months ago
package.json 67e28e9071 Initial commit 11 months ago
yarn.lock 67e28e9071 Initial commit 11 months ago

README.md

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

"use strict";

const postgresqlSocketUrl = require("postgresql-socket-url");

let url = postgresqlSocketUrl({
	socketPath: "/tmp",
	database: "myproject"
});

console.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.0 (September 14, 2019)

Initial release.