Class FetchEffect

function

• function(this): ((requestInfo, requestInit?) => Promise<Response>)

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

  Parameters

  • this: StateWorker

    The explicit polymorphic this parameter.

  Returns ((requestInfo, requestInit?) => Promise<Response>)

  This FetchEffect bound to the StateWorker.

  • • (requestInfo, requestInit?): Promise<Response>

    • Implanted FetchEffect providing convenient access to the globalThis.fetch method within Store.Actions. Prefer the usage of this Effect over the globalThis.fetch method when StateWorker.dispatching Store.Actions.

      Parameters

      • requestInfo: URL | RequestInfo

        The RequestInfo or URL to fetch.
      • Optional requestInit: RequestInit

        An optional RequestInit object.

      Returns Promise<Response>

      A Promise of the fetched Response.

      Example

      Invoke fetch within an Store.Action:

      import { Stateful, Store } from '@sgrud/state';
      
      ⁠@Stateful('io.github.sgrud.store.example', { response: undefined })
      export class ExampleStore extends Store<ExampleStore> {
      
        public readonly response?: unknown;
      
        public async getResponse(url: string): Promise<Store.State<this>> {
          const request = await sgrud.state.effects.fetch(url);
          const response = await request.json();
      
          if (!request.ok) {
            throw response;
          }
      
          return { ...this, response };
        }
      
      }
      Copy

      See

      FetchEffect