Class StateEffect

function

• function(this): (<T>(handle) => Promise<Store.State<T> | undefined>)

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

  Parameters

  • this: StateWorker

    The explicit polymorphic this parameter.

  Returns (<T>(handle) => Promise<Store.State<T> | undefined>)

  This StateEffect bound to the StateWorker.

  • • <T>(handle): Promise<Store.State<T> | undefined>

    • Implanted StateEffect providing convenient access to the state of Stores from within StateWorker.dispatched Store.Actions. This StateEffect in combination with the DispatchEffect 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.

      Returns Promise<Store.State<T> | undefined>

      The current state of the Store.

      Example

      Retrieve the state from 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 getState(handle: Bus.Handle): Promise<Store.State<this>> {
          const state = await sgrud.state.effects.state(handle);
      
          return { ...this, state };
        }
      
      }
      Copy

      See

      StateEffect