feat(subscribe): pass context to callback

Author: ArrayZoneYour

README.md

@@ -96,7 +96,7 @@ npm install react-model
   - [How can I add custom middleware](#how-can-i-add-custom-middleware)
     - [How can I make persist models](#how-can-i-make-persist-models)
   - [How can I deal with local state](#how-can-i-deal-with-local-state)
-  - [How can I deal with huge dataset / circular dataset](#how-can-i-deal-with-huge-dataset-/-circular-dataset)
+  - [How can I deal with huge dataset / circular dataset](#how-can-i-deal-with-huge-dataset--circular-dataset)
   - [actions throw error from immer.module.js](#actions-throw-error-from-immermodulejs)
   - [How can I customize each model's middlewares?](#how-can-i-customize-each-models-middlewares)
 

__test__/middlewares/subscribe.spec.ts

@@ -7,11 +7,15 @@ describe('Subscribe middleware', () => {
   test('run callback when specific action run', async () => {
     let actions: any
     let count = 0
+    let incrementCount = 0
     const Counter = Model(NextCounter)
     const { useStore, subscribe } = Model({ Counter })
     subscribe('Counter', ['increment'], () => (count += 1))
     subscribe('Counter', 'add', () => (count += 10))
     subscribe('Counter', ['increment', 'add'], () => (count += 5))
+    subscribe('Counter', 'increment', ({ params }) => {
+      incrementCount += params || 1
+    })
     renderHook(() => {
       ;[, actions] = useStore('Counter')
     })
@@ -22,5 +26,10 @@ describe('Subscribe middleware', () => {
     expect(count).toBe(33)
     await actions.addCaller()
     expect(count).toBe(48)
+    expect(incrementCount).toBe(3)
+    await actions.increment(10)
+    expect(incrementCount).toBe(13)
+    await actions.increment(-3)
+    expect(incrementCount).toBe(10)
   })
 })

src/index.d.ts

@@ -70,13 +70,13 @@ interface ModelContext {
   modelName: string
 }
 
-interface BaseContext<S = {}> {
+interface BaseContext<S = {}, P = any> {
   action: Action
   consumerActions: (
     actions: Actions,
     modelContext: ModelContext
   ) => getConsumerActionsType<Actions>
-  params: Object
+  params: P
   middlewareConfig?: Object
   actionName: string
   modelName: string
@@ -135,7 +135,7 @@ interface API<MT extends ModelType = ModelType<any, any, {}>> {
   getState: () => Readonly<Get<MT, 'state'>>
   subscribe: (
     actionName: keyof MT['actions'] | Array<keyof MT['actions']>,
-    callback: () => void
+    callback: (context: BaseContext) => void
   ) => void
   unsubscribe: (
     actionName: keyof Get<MT, 'actions'> | Array<keyof Get<MT, 'actions'>>
@@ -194,7 +194,7 @@ interface APIs<M extends Models> {
   subscribe: <K extends keyof M>(
     modelName: K,
     actionName: keyof Get<M[K], 'actions'> | Array<keyof Get<M[K], 'actions'>>,
-    callback: () => void
+    callback: (context: BaseContext) => void
   ) => void
   unsubscribe: <K extends keyof M>(
     modelName: K,

src/middlewares.ts

@@ -96,7 +96,7 @@ const subscription: Middleware = async (context, restMiddlewares) => {
   const subscriptions = Global.subscriptions[`${modelName}_${actionName}`]
   if (subscriptions) {
     subscriptions.forEach((callback) => {
-      callback()
+      callback(context)
     })
   }
   await next(restMiddlewares)