Documentation / @warp-drive/ember / getRequestState

Function: getRequestState()

function getRequestState<RT, E>(future): Readonly<RequestState<RT, StructuredErrorDocument<E>>>;

Defined in: warp-drive-packages/core/declarations/store/-private/new-core-tmp/request-state.d.ts:369

getRequestState can be used in both JavaScript and Template contexts.

import { getRequestState } from '@warp-drive/ember';

const state = getRequestState(future);

For instance, we could write a getter on a component that updates whenever the request state advances or the future changes, by combining the function with the use of @cached

class Component {
  @cached
  get title() {
    const state = getRequestState(this.args.request);
    if (state.isPending) {
      return 'loading...';
    }
    if (state.isError) { return null; }
    return state.result.title;
  }
}

Or in a template as a helper:

import { getRequestState } from '@warp-drive/ember';

<template>
  {{#let (getRequestState @request) as |state|}}
    {{#if state.isPending}}
      <Spinner />
    {{else if state.isError}}
      <ErrorForm @error={{state.error}} />
    {{else}}
      <h1>{{state.result.title}}</h1>
    {{/if}}
  {{/let}}
</template>

If looking to use in a template, consider also the <Request /> component which offers a numbe of additional capabilities for requests beyond what RequestState provides.

Type Parameters

RT

RT

E

E

Parameters

future

Future<RT>

Returns

Readonly<RequestState<RT, StructuredErrorDocument<E>>>