Fix TypeScript definition and rely on compilation to create typings.

ryanbarr · Apr 10, 2023 · 5b2eadb · 5b2eadb
1 parent 0e9270a
commit 5b2eadb
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 29 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/.gitignore b/.gitignore
@@ -1 +1,3 @@
-node_modules
+dist
+node_modules
+localgeneric*.tgz
diff --git a/index.d.ts b/index.d.ts
diff --git a/index.js → index.ts b/index.js → index.ts
@@ -1,6 +1,8 @@
-export class GenericStore {
-  constructor(key, defaults) {
-    const proto = { ...GenericStore.prototype };
+export class _GenericStore<T> {
+  public key: string;
+
+  constructor(key: string, defaults?: T) {
+    const proto = { ..._GenericStore.prototype };
     if (defaults) Object.assign(proto, Object.getPrototypeOf(defaults));
     Object.setPrototypeOf(this, proto);
     Object.assign(this, defaults);
@@ -19,7 +21,7 @@ export class GenericStore {
     return data ? JSON.parse(data) : null;
   };
 
-  set = (value) => {
+  set = (value: T | Partial<T>) => {
     Object.assign(this, value);
     return window.localStorage.setItem(
       this.key,
@@ -30,4 +32,7 @@ export class GenericStore {
   };
 }
 
-export const Store = GenericStore;
+type GenericStore<T> = _GenericStore<T> & T;
+
+export const Store: new <T>(key: string, data?: T) => GenericStore<T> =
+  _GenericStore as any;
diff --git a/package.json b/package.json
@@ -2,14 +2,12 @@
   "name": "localgeneric",
   "version": "1.1.3",
   "description": "Local Storage wrapper with TypeScript generics support.",
-  "main": "index.js",
-  "typings": "index.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
+    "build": "tsc",
     "test": "jest --env=jsdom"
   },
-  "files": [
-    "index.ts"
-  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ryanbarr/localgeneric.git"

diff --git a/tests/store.test.ts b/tests/store.test.ts
@@ -1,4 +1,4 @@
-import { Store } from "../index.js";
+import { Store } from "../index";
 
 describe("string stores", () => {
   const store = new Store<string>("stringStores", "J. Doe");

diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "module": "commonjs",
+    "lib": ["es2017", "es7", "es6", "dom"],
+    "declaration": true,
+    "outDir": "dist",
+    "strict": true,
+    "esModuleInterop": true
+  },
+  "files": [
+    "index.ts"
+  ],
+}