v1.4.0 TS Support (#61)

Co-authored-by: Charles Burgess <[email protected]>

Author: freshollie

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v1.4.0 - 03-27-2021
+
+- Add Typescript types ( Thanks @freshollie )
+
 ## v1.3.1 - 12-11-2020
 
 - Various dependency security updates via dependabot

index.d.ts

@@ -0,0 +1,13 @@
+import Knex from "knex";
+import { DataSource } from "apollo-datasource";
+
+declare module "knex" {
+  interface QueryBuilder<TRecord extends {} = any, TResult = any> {
+    cache: (ttl?: number) => QueryBuilder<TRecord, TResult>;
+  }
+}
+
+export class SQLDataSource extends DataSource {
+  protected knex: Knex;
+  constructor(config: Knex.Config | Knex);
+}

index.test-d.ts

@@ -0,0 +1,47 @@
+import { expectError, expectType } from "tsd";
+import Knex from "knex";
+import { SQLDataSource } from "./index";
+
+type MyRow = { id: string; value: number };
+class MyTestDataSource extends SQLDataSource {
+  public testKnexExists() {
+    expectType<Knex>(this.knex);
+  }
+
+  public async testCacheFunctionPassesResult() {
+    expectType<MyRow[]>(
+      await this.knex<MyRow>("mytable")
+        .select("id", "value")
+        .where("id", "1")
+        .cache()
+    );
+  }
+
+  public async testCacheFunctionAcceptsTTL() {
+    expectType<MyRow[]>(
+      await this.knex<MyRow>("mytable")
+        .select("id", "value")
+        .where("id", "1")
+        .cache(5)
+    );
+  }
+}
+
+new MyTestDataSource({
+  connection: {
+    port: 80,
+    host: "somethimg"
+  }
+});
+
+new MyTestDataSource(
+  Knex({
+    connection: {
+      port: 80,
+      host: "something"
+    }
+  })
+);
+
+expectError(new MyTestDataSource("something not knex config"));
+expectError(new MyTestDataSource());