update documentation

Author: williamhorning

Dockerfile

@@ -1,4 +1,4 @@
-FROM denoland/deno:alpine-2.1.4
+FROM denoland/deno:alpine-2.2.11
 WORKDIR /app
 
 # Install wait utility

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2022 Bartłomiej Iwańczuk and Steven Guerrero
+Copyright (c) 2018-2025 Bartłomiej Iwańczuk, Steven Guerrero, and Hector Ayala
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,20 +2,22 @@
 
 ![Build Status](https://img.shields.io/github/actions/workflow/status/denodrivers/postgres/ci.yml?branch=main&label=Build&logo=github&style=flat-square)
 [![Discord server](https://img.shields.io/discord/768918486575480863?color=blue&label=Ask%20for%20help%20here&logo=discord&style=flat-square)](https://discord.gg/HEdTCvZUSf)
+[![JSR](https://jsr.io/badges/@db/postgres?style=flat-square)](https://jsr.io/@db/postgres)
+[![JSR Score](https://jsr.io/badges/@db/postgres/score?style=flat-square)](https://jsr.io/@db/postgres)
 [![Manual](https://img.shields.io/github/v/release/denodrivers/postgres?color=orange&label=Manual&logo=deno&style=flat-square)](https://deno-postgres.com)
-[![Documentation](https://img.shields.io/github/v/release/denodrivers/postgres?color=yellow&label=Documentation&logo=deno&style=flat-square)](https://doc.deno.land/https/deno.land/x/postgres/mod.ts)
+[![Documentation](https://img.shields.io/github/v/release/denodrivers/postgres?color=yellow&label=Documentation&logo=deno&style=flat-square)](https://jsr.io/@db/postgres/doc)
 [![License](https://img.shields.io/github/license/denodrivers/postgres?color=yellowgreen&label=License&style=flat-square)](LICENSE)
 
 A lightweight PostgreSQL driver for Deno focused on developer experience.
 
-`deno-postgres` is being developed inspired by the excellent work of
+`deno-postgres` is inspired by the excellent work of
 [node-postgres](https://github.com/brianc/node-postgres) and
 [pq](https://github.com/lib/pq).
 
 ## Documentation
 
-The documentation is available on the `deno-postgres` website
-[https://deno-postgres.com/](https://deno-postgres.com/)
+The documentation is available on the
+[`deno-postgres` website](https://deno-postgres.com/).
 
 Join the [Discord](https://discord.gg/HEdTCvZUSf) as well! It's a good place to
 discuss bugs and features before opening issues.
@@ -32,6 +34,7 @@ const client = new Client({
   hostname: "localhost",
   port: 5432,
 });
+
 await client.connect();
 
 {
@@ -59,6 +62,40 @@ await client.connect();
 await client.end();
 ```
 
+## Deno compatibility
+
+Due to breaking changes introduced in the unstable APIs `deno-postgres` uses,
+there has been some fragmentation regarding what versions of Deno can be used
+alongside the driver.
+
+This situation will stabilize as `deno-postgres` approach version 1.0.
+
+| Deno version  | Min driver version | Max version         | Note                                                                           |
+| ------------- | ------------------ | ------------------- | ------------------------------------------------------------------------------ |
+| 1.8.x         | 0.5.0              | 0.10.0              |                                                                                |
+| 1.9.0         | 0.11.0             | 0.11.1              |                                                                                |
+| 1.9.1 and up  | 0.11.2             | 0.11.3              |                                                                                |
+| 1.11.0 and up | 0.12.0             | 0.12.0              |                                                                                |
+| 1.14.0 and up | 0.13.0             | 0.13.0              |                                                                                |
+| 1.16.0        | 0.14.0             | 0.14.3              |                                                                                |
+| 1.17.0        | 0.15.0             | 0.17.1              |                                                                                |
+| 1.40.0        | 0.17.2             | currently supported | 0.17.2 [on JSR](https://jsr.io/@bartlomieju/postgres)                          |
+| 2.0.0 and up  | 0.19.4             | currently supported | All versions available as [`@db/postgres` on JSR](https://jsr.io/@db/postgres) |
+
+## Breaking changes
+
+Although `deno-postgres` is reasonably stable and robust, it is a WIP, and we're
+still exploring the design. Expect some breaking changes as we reach version 1.0
+and enhance the feature set. Please check the Releases for more info on breaking
+changes. Please reach out if there are any undocumented breaking changes.
+
+## Found issues?
+
+Please
+[file an issue](https://github.com/denodrivers/postgres/issues/new/choose) with
+any problems with the driver. If you would like to help, please look at the
+issues as well. You can pick up one of them and try to implement it.
+
 ## Contributing
 
 ### Prerequisites
@@ -73,8 +110,8 @@ await client.end();
   it to run the linter and formatter locally
 
   - https://deno.land/
-  - `deno upgrade --version 1.40.0`
-  - `dvm install 1.40.0 && dvm use 1.40.0`
+  - `deno upgrade stable`
+  - `dvm install stable && dvm use stable`
 
 - You don't need to install Postgres locally on your machine to test the
   library; it will run as a service in the Docker container when you build it
@@ -96,8 +133,8 @@ It is recommended that you don't rely on any previously initialized data for
 your tests instead create all the data you need at the moment of running the
 tests
 
-For example, the following test will create a temporal table that will disappear
-once the test has been completed
+For example, the following test will create a temporary table that will
+disappear once the test has been completed
 
 ```ts
 Deno.test("INSERT works correctly", async () => {
@@ -134,41 +171,6 @@ a local testing environment, as shown in the following steps:
 3. Run the tests manually by using the command\
    `deno test -A`
 
-## Deno compatibility
-
-Due to breaking changes introduced in the unstable APIs `deno-postgres` uses,
-there has been some fragmentation regarding what versions of Deno can be used
-alongside the driver.
-
-This situation will stabilize as `std` and `deno-postgres` approach version 1.0.
-
-| Deno version  | Min driver version | Max driver version | Note                 |
-| ------------- | ------------------ | ------------------ | -------------------- |
-| 1.8.x         | 0.5.0              | 0.10.0             |                      |
-| 1.9.0         | 0.11.0             | 0.11.1             |                      |
-| 1.9.1 and up  | 0.11.2             | 0.11.3             |                      |
-| 1.11.0 and up | 0.12.0             | 0.12.0             |                      |
-| 1.14.0 and up | 0.13.0             | 0.13.0             |                      |
-| 1.16.0        | 0.14.0             | 0.14.3             |                      |
-| 1.17.0        | 0.15.0             | 0.17.1             |                      |
-| 1.40.0        | 0.17.2             |                    | Now available on JSR |
-
-## Breaking changes
-
-Although `deno-postgres` is reasonably stable and robust, it is a WIP, and we're
-still exploring the design. Expect some breaking changes as we reach version 1.0
-and enhance the feature set. Please check the Releases for more info on breaking
-changes. Please reach out if there are any undocumented breaking changes.
-
-## Found issues?
-
-Please
-[file an issue](https://github.com/denodrivers/postgres/issues/new/choose) with
-any problems with the driver in this repository's issue section. If you would
-like to help, please look at the
-[issues](https://github.com/denodrivers/postgres/issues) as well. You can pick
-up one of them and try to implement it.
-
 ## Contributing guidelines
 
 When contributing to the repository, make sure to:
@@ -194,5 +196,5 @@ preserved their individual licenses and copyrights.
 
 Everything is licensed under the MIT License.
 
-All additional work is copyright 2018 - 2024 — Bartłomiej Iwańczuk, Steven
+All additional work is copyright 2018 - 2025 — Bartłomiej Iwańczuk, Steven
 Guerrero, Hector Ayala — All rights reserved.

docs/README.md

@@ -1,10 +1,12 @@
 # deno-postgres
 
-![Build Status](https://img.shields.io/github/workflow/status/denodrivers/postgres/ci?label=Build&logo=github&style=flat-square)
+![Build Status](https://img.shields.io/github/actions/workflow/status/denodrivers/postgres/ci.yml?branch=main&label=Build&logo=github&style=flat-square)
 [![Discord server](https://img.shields.io/discord/768918486575480863?color=blue&label=Ask%20for%20help%20here&logo=discord&style=flat-square)](https://discord.gg/HEdTCvZUSf)
-![Manual](https://img.shields.io/github/v/release/denodrivers/postgres?color=orange&label=Manual&logo=deno&style=flat-square)
-[![Documentation](https://img.shields.io/github/v/release/denodrivers/postgres?color=yellow&label=Documentation&logo=deno&style=flat-square)](https://doc.deno.land/https/deno.land/x/postgres/mod.ts)
-![License](https://img.shields.io/github/license/denodrivers/postgres?color=yellowgreen&label=License&style=flat-square)
+[![JSR](https://jsr.io/badges/@db/postgres?style=flat-square)](https://jsr.io/@db/postgres)
+[![JSR Score](https://jsr.io/badges/@db/postgres/score?style=flat-square)](https://jsr.io/@db/postgres)
+[![Manual](https://img.shields.io/github/v/release/denodrivers/postgres?color=orange&label=Manual&logo=deno&style=flat-square)](https://deno-postgres.com)
+[![Documentation](https://img.shields.io/github/v/release/denodrivers/postgres?color=yellow&label=Documentation&logo=deno&style=flat-square)](https://jsr.io/@db/postgres/doc)
+[![License](https://img.shields.io/github/license/denodrivers/postgres?color=yellowgreen&label=License&style=flat-square)](LICENSE)
 
 `deno-postgres` is a lightweight PostgreSQL driver for Deno focused on user
 experience. It provides abstractions for most common operations such as typed
@@ -114,7 +116,7 @@ of search parameters such as the following:
 - password: If password is not specified in the url, this will be taken instead
 - port: If port is not specified in the url, this will be taken instead
 - options: This parameter can be used by other database engines usable through
-  the Postgres protocol (such as Cockroachdb for example) to send additional
+  the Postgres protocol (such as CockroachDB for example) to send additional
   values for connection (ej: options=--cluster=your_cluster_name)
 - sslmode: Allows you to specify the tls configuration for your client; the
   allowed values are the following:
@@ -231,9 +233,6 @@ instead of TCP by providing the route to the socket file your Postgres database
 creates automatically. You can manually set the protocol used with the
 `host_type` property in the client options
 
-**Note**: This functionality is only available on UNIX systems under the
-`--unstable` flag
-
 In order to connect to the socket you can pass the path as a host in the client
 initialization. Alternatively, you can specify the port the database is
 listening on and the parent folder of the socket as a host (The equivalent of
@@ -343,8 +342,8 @@ certificate to encrypt your connection that, if not taken care of, can render
 your certificate invalid.
 
 When using a self-signed certificate, make sure to specify the PEM encoded CA
-certificate using the `--cert` option when starting Deno (Deno 1.12.2 or later)
-or in the `tls.caCertificates` option when creating a client (Deno 1.15.0 later)
+certificate using the `--cert` option when starting Deno or in the
+`tls.caCertificates` option when creating a client
 
 ```ts
 const client = new Client({
@@ -1452,7 +1451,7 @@ await transaction.commit();
 The driver can provide different types of logs if as needed. By default, logs
 are disabled to keep your environment as uncluttered as possible. Logging can be
 enabled by using the `debug` option in the Client `controls` parameter. Pass
-`true` to enable all logs, or turn on logs granulary by enabling the following
+`true` to enable all logs, or turn on logs granularity by enabling the following
 options:
 
 - `queries` : Logs all SQL queries executed by the client
@@ -1497,7 +1496,7 @@ AS $function$
   BEGIN
     RAISE INFO 'This function generates a random UUID :)';
     RAISE NOTICE 'A UUID takes up 128 bits in memory.';
-    RAISE WARNING 'UUIDs must follow a specific format and lenght in order to be valid!';
+    RAISE WARNING 'UUIDs must follow a specific format and length in order to be valid!';
     RETURN gen_random_uuid();
   END;
 $function$;;

docs/index.html

@@ -1,28 +1,31 @@
 <!DOCTYPE html>
 <html lang="en">
   <head>
-    <meta charset="UTF-8">
+    <meta charset="UTF-8" />
     <title>Deno Postgres</title>
     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
     <meta
       name="description"
       content="🦕 Lightweight PostgreSQL driver for Deno focused on developer experience"
-    >
+    />
     <meta
       name="viewport"
       content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
-    >
-    <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
+    />
+    <link
+      rel="stylesheet"
+      href="//cdn.jsdelivr.net/npm/docsify@4/themes/vue.css"
+    />
   </head>
   <body>
     <div id="app"></div>
     <script>
       window.$docsify = {
         name: "deno-postgres",
-        repo: "buildondata/deno-postgres",
+        repo: "denodrivers/postgres",
       };
     </script>
-    <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
-    <script src="//unpkg.com/prismjs/components/prism-typescript.min.js"></script>
+    <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+    <script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-typescript.min.js"></script>
   </body>
 </html>

mod.ts

@@ -5,12 +5,7 @@ export {
   TransactionError,
 } from "./client/error.ts";
 export { Pool } from "./pool.ts";
-export { Oid, OidTypes } from "./query/oid.ts";
-
-// TODO
-// Remove the following reexports after https://doc.deno.land
-// supports two level depth exports
-export type { OidType, OidValue } from "./query/oid.ts";
+export { Oid, type OidType, OidTypes, type OidValue } from "./query/oid.ts";
 export type {
   ClientOptions,
   ConnectionOptions,