Merge pull request #4 from pizzahutuk/types

added typescript definition
pizzahutuk · Jun 27, 2019 · e69fe81 · e69fe81
2 parents ba7e44b + 679b64a
commit e69fe81
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,19 @@
+export = Credstash;
+
+declare class Credstash {
+  list(options: Credstash.IOptions, callback: Credstash.Callback<string[]>): void;
+  list(callback: Credstash.Callback<string[]>): void;
+
+  get(value: string, options: Credstash.IOptions, callback: Credstash.Callback<string>): void;
+  get(value: string, callback: Credstash.Callback<string>): void;
+}
+
+declare namespace Credstash {
+  type Callback<T> = (err: Error | null, response: T) => void;
+
+  interface IOptions {
+    limit?: number,
+    region?: string,
+    table?: string
+  }
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@pizza-hut/credstash",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Module for reading credstash secrets",
   "main": "index.js",
   "scripts": {