fix: type definition #11

Author: distolma

.npmignore

@@ -4,7 +4,7 @@ npm-debug.log
 yarn-error.log
 yarn.lock
 
-*.spec.js
+*.test.js
 .travis.yml
 
 node_modules/

README.md

@@ -34,15 +34,33 @@ Use `createSvelteStore` from the `@storeon/svelte` package instead of using `cre
 import { createSvelteStore } from "@storeon/svelte";
 
 let counter = store => {
-  // Initial state
   store.on("@init", () => ({ count: 0 }));
-  // Reducers returns only changed part of the state
   store.on("inc", ({ count }) => ({ count: count + 1 }));
 };
 
 export const connect = createSvelteStore([counter]);
 ```
 
+Using TypeScript you can pass `State` interface to the `createSvelteStore` function
+
+#### `store.ts`
+
+```typescript
+import { Store } from 'storeon';
+import { createSvelteStore } from "@storeon/svelte";
+
+interface State {
+  count: number;
+}
+
+let counter = (store: Store<State>) => {
+  store.on("@init", () => ({ count: 0 }));
+  store.on("inc", ({ count }) => ({ count: count + 1 }));
+};
+
+export const connect = createSvelteStore<State>([counter]);
+```
+
 Import `connect` function from our `./store` and use it for getting state and dispatching new events
 
 #### `App.svelte`

index.d.ts

@@ -1,7 +1,7 @@
-import { Dispatch } from "storeon";
+import { Module, Dispatch } from 'storeon';
 
-declare function createSvelteStore<T>(
-  modules: any[]
-): (key: string) => [Dispatch, any];
+interface Changes<State, K extends keyof State> {
+    subscribe: (run: (state: State[K]) => void) => () => void;
+}
 
-export { createSvelteStore };
+export declare function createSvelteStore<State>(modules: Module<State>[]): <K extends keyof State>(key: K) => [Dispatch, Changes<State, K>];