Class DispatchEffect

function

• function(this): (<T>(handle, ...action) => Promise<Store.State<T>>)

• Overridden function binding the DispatchEffect to the polymorphic this of the StateWorker.

  Parameters

  • this: StateWorker

    The explicit polymorphic this parameter.

  Returns (<T>(handle, ...action) => Promise<Store.State<T>>)

  This DispatchEffect bound to the StateWorker.

  • • <T>(handle, ...action): Promise<Store.State<T>>

    • Implanted DispatchEffect providing a convenient way to dispatch Store.Actions from within Store.Actions. This DispatchEffect in combination with the StateEffect can be used to implement complex interactions between different Stores.

      Type Parameters

      • T extends Store<any>

        The extending Store InstanceType.

      Parameters

      • handle: Handle

        The Bus.Handle representing the Store.
      • Rest ...action: Store.Action<T>

        A type-guarded Store.Action to dispatch.

      Returns Promise<Store.State<T>>

      The next Store.State after dispatching.

      Example

      dispatch an Store.Action to another Store:

      import { type Bus } from '@sgrud/bus';
      import { Stateful, Store } from '@sgrud/state';
      
      ⁠@Stateful('io.github.sgrud.store.example', { state: undefined })
      export class ExampleStore extends Store<ExampleStore> {
      
        public readonly state?: Store.State<Store>;
      
        public async dispatchAction<T extends Store>(
          handle: Bus.Handle,
          ...action: Store.Action<T>
        ): Promise<Store.State<this>> {
          const state = await sgrud.state.effects.dispatch<T>(
            handle, ...action
          );
      
          return { ...this, state };
        }
      
      }
      Copy

      See

      DispatchEffect