types: add subscribe options type (#1724)

vuejs · Apr 23, 2020 · e2b9974 · e2b9974
1 parent 38c11dc
commit e2b9974
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -18,8 +18,8 @@ export declare class Store<S> {
   dispatch: Dispatch;
   commit: Commit;
 
-  subscribe<P extends MutationPayload>(fn: (mutation: P, state: S) => any): () => void;
-  subscribeAction<P extends ActionPayload>(fn: SubscribeActionOptions<P, S>): () => void;
+  subscribe<P extends MutationPayload>(fn: (mutation: P, state: S) => any, options?: SubscribeOptions): () => void;
+  subscribeAction<P extends ActionPayload>(fn: SubscribeActionOptions<P, S>, options?: SubscribeOptions): () => void;
   watch<T>(getter: (state: S, getters: any) => T, cb: (value: T, oldValue: T) => void, options?: WatchOptions): () => void;
 
   registerModule<T>(path: string, module: Module<T, S>, options?: ModuleOptions): void;
@@ -72,6 +72,10 @@ export interface ActionPayload extends Payload {
   payload: any;
 }
 
+export interface SubscribeOptions {
+  prepend?: boolean
+}
+
 export type ActionSubscriber<P, S> = (action: P, state: S) => any;
 
 export interface ActionSubscribersObject<P, S> {

diff --git a/types/test/index.ts b/types/test/index.ts
@@ -39,6 +39,8 @@ namespace StoreInstance {
     state.value;
   });
 
+  store.subscribe(() => {}, { prepend: true });
+
   store.subscribeAction((action, state) => {
     action.type;
     action.payload;
@@ -74,6 +76,8 @@ namespace StoreInstance {
     }
   });
 
+  store.subscribeAction({}, { prepend: true });
+
   store.replaceState({ value: 10 });
 }