fix(types): initial types for use with TypeScript

5app · Sep 29, 2021 · cee7d39 · cee7d39
1 parent 40d23ad
commit cee7d39
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/@types/index.d.ts b/@types/index.d.ts
@@ -0,0 +1,17 @@
+interface DigitalHubApiConstructorOptions {
+	username: string;
+	password: string;
+	tenant: string;
+}
+
+interface DigitalHubApiCallOptions {
+	path: string;
+	method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
+	body?: any;
+	json?: boolean;
+}
+
+export default class DigitalHubApi {
+	constructor(options: DigitalHubApiConstructorOptions);
+	api(options: DigitalHubApiCallOptions): Promise<Response | Object>;
+}
diff --git a/package.json b/package.json
@@ -6,6 +6,7 @@
   "engines": {
     "node": ">=14.17.0"
   },
+  "types": "./@types/index.d.ts",
   "scripts": {
     "lint": "eslint ./",
     "lint-fix": "eslint --fix ./",