Add TypeScript typings (#63)

* feat: add typescript typings

Author: Evgeny Markov

README.md

@@ -203,6 +203,16 @@ fastify.listen(3000, err => {
 })
 ```
 
+## TypeScript Usage
+
+Install the compiler and typings for pg module:
+
+```shell script
+npm install --save-dev typescript @types/pg
+```
+
+You can find examples in the [examples/typescript](./examples/typescript) directory.
+
 ## Development and Testing
 
 First, start postgres with:

examples/typescript/multiple-db/app.ts

@@ -0,0 +1,37 @@
+import fastify from 'fastify';
+
+import { fastifyPostgres } from '../../../index';
+
+const app = fastify();
+
+app.register(fastifyPostgres, {
+  name: 'sum',
+  connectionString: 'postgres://user:password@host:port/sub-db',
+});
+
+app.register(fastifyPostgres, {
+  name: 'sub',
+  connectionString: 'postgres://user:password@host:port/sub-db',
+});
+
+app.get('/calc', async () => {
+  const sumClient = await app.pg.sum.connect();
+  const subClient = await app.pg.sub.connect();
+
+  const sumResult = await sumClient.query<{ sum: number }>(
+    'SELECT 2 + 2 as sum'
+  );
+  const subResult = await subClient.query<{ sub: number }>(
+    'SELECT 6 - 3 as sub'
+  );
+
+  sumClient.release();
+  subClient.release();
+
+  return {
+    sum: sumResult.rows,
+    sub: subResult.rows,
+  };
+});
+
+export { app };

examples/typescript/multiple-db/fastify.d.ts

@@ -0,0 +1,10 @@
+import type { PostgresDb } from '../../../index';
+
+declare module 'fastify' {
+  export interface FastifyInstance {
+    pg: {
+      sum: PostgresDb;
+      sub: PostgresDb;
+    };
+  }
+}

examples/typescript/multiple-db/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "@tsconfig/node10/tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+  }
+}

examples/typescript/single-db/app.ts

@@ -0,0 +1,23 @@
+import fastify from 'fastify';
+
+import { fastifyPostgres } from '../../../index';
+
+const app = fastify();
+
+app.register(fastifyPostgres, {
+  connectionString: 'postgres://user:password@host:port/db',
+});
+
+app.get('/calc', async () => {
+  const client = await app.pg.connect();
+
+  const sumResult = await client.query<{ sum: number }>('SELECT 2 + 2 as sum');
+
+  client.release();
+
+  return {
+    sum: sumResult.rows,
+  };
+});
+
+export { app };

examples/typescript/single-db/fastify.d.ts

@@ -0,0 +1,7 @@
+import type { PostgresDb } from '../../../index';
+
+declare module 'fastify' {
+  export interface FastifyInstance {
+    pg: PostgresDb;
+  }
+}

examples/typescript/single-db/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "@tsconfig/node10/tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+  }
+}

examples/typescript/transactions/app.ts

@@ -0,0 +1,51 @@
+import fastify from 'fastify';
+
+import { fastifyPostgres } from '../../../index';
+
+const app = fastify();
+
+app.register(fastifyPostgres, {
+  connectionString: 'postgres://user:password@host:port/db',
+});
+
+app.post('/init-async', async () => {
+  const createTableQuery = `
+    CREATE TABLE routes (
+      id bigserial primary key,
+      name varchar(80) NOT NULL,
+      created_at timestamp default NULL
+    );
+  `;
+
+  return app.pg.transact(async (client) => {
+    const result = await client.query(createTableQuery);
+
+    return result;
+  });
+});
+
+app.post('/init-cb', (_req, reply) => {
+  const createTableQuery = `
+    CREATE TABLE routes (
+      id bigserial primary key,
+      name varchar(80) NOT NULL,
+      created_at timestamp default NULL
+    );
+  `;
+
+  app.pg.transact(
+    (client) => {
+      return client.query(createTableQuery);
+    },
+    (error, result) => {
+      if (error) {
+        reply.status(500).send(error);
+        return;
+      }
+
+      reply.status(200).send(result);
+    }
+  );
+});
+
+export { app };

examples/typescript/transactions/fastify.d.ts

@@ -0,0 +1,7 @@
+import type { PostgresDb } from '../../../index';
+
+declare module 'fastify' {
+  export interface FastifyInstance {
+    pg: PostgresDb;
+  }
+}

examples/typescript/transactions/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "@tsconfig/node10/tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+  }
+}