useController()

O Controller fornece métodos com tipagem segura para acessar o store e despachar actions para ele.

Por exemplo fetch, invalidate e setResponse

<script setup lang="ts">
  import { useController } from '@data-client/vue';
  import { MyResource } from './resources';

  const props = defineProps<{ id: string }>();
  const ctrl = useController();

  const handleRefresh = async () => {
    await ctrl.fetch(MyResource.get, { id: props.id });
  };

  const handleSuspend = async () => {
    await ctrl.invalidate(MyResource.get, { id: props.id });
  };

  const handleLogout = () => {
    ctrl.resetEntireStore();
  };
</script>

useController() deve ser chamado dentro de <script setup> (ou setup()) e exige que o DataClientPlugin esteja instalado. O mesmo Controller também está disponível nos templates e na Options API como $dataClient.

Exemplos

Envio de formulário

fetch retorna a resposta desnormalizada, correspondendo ao tipo de retorno de useSuspense(). Isso permite usar métodos de Entity como pk().

CreatePost.vue

<script setup lang="ts">
  import { useController } from '@data-client/vue';
  import { useRouter } from 'vue-router';
  import { PostResource } from './PostResource';

  const ctrl = useController();
  const router = useRouter();

  const handleSubmit = async (e: Event) => {
    e.preventDefault();
    const post = await ctrl.fetch(
      PostResource.getList.push,
      new FormData(e.target as HTMLFormElement),
    );
    post.title;
    post.computedField;
    router.push(`/post/${post.pk()}`);
  };
</script>

<template>
  <form @submit="handleSubmit"><!-- fields --></form>
</template>

Atualização direta de entity

Use set para atualizações imediatas, sem requisições de rede. Oferece suporte a atualizações funcionais para evitar condições de corrida.

VoteButton.vue

<script setup lang="ts">
  import { useController } from '@data-client/vue';
  import { Article } from './Article';

  const props = defineProps<{ articleId: string }>();
  const ctrl = useController();

  const vote = () =>
    ctrl.set(Article, { id: props.articleId }, article => ({
      ...article,
      votes: article.votes + 1,
    }));
</script>

<template>
  <button @click="vote">Vote</button>
</template>

Invalidar após uma mutação

Force um novo fetch dos dados relacionados usando invalidate ou expireAll.

ClearUserCache.vue

<script setup lang="ts">
  import { useController } from '@data-client/vue';
  import { UserResource } from './UserResource';

  const ctrl = useController();

  const handleClear = async () => {
    // invalidate() causes suspense; expireAll() refetches silently
    ctrl.expireAll(UserResource.get);
    ctrl.expireAll(UserResource.getList);
  };
</script>

<template>
  <button @click="handleClear">Refresh user data</button>
</template>

dica

Para melhor desempenho e consistência, prefira incluir as atualizações de efeitos colaterais nas respostas das mutações.

Prefetching

Use fetchIfStale para fazer prefetch sem buscar novamente dados que ainda estão atualizados.

ArticleLink.vue

<script setup lang="ts">
  import { useController } from '@data-client/vue';
  import { ArticleResource } from './ArticleResource';

  const props = defineProps<{ id: string }>();
  const ctrl = useController();

  const prefetch = () =>
    ctrl.fetchIfStale(ArticleResource.get, { id: props.id });
</script>

<template>
  <RouterLink :to="`/article/${id}`" @mouseenter="prefetch">
    Read more
  </RouterLink>
</template>

Atualizações via websocket

Preencha o cache com dados externos por meio de set.

useWebsocket.ts

import { onMounted, onUnmounted } from 'vue';
import { useController } from '@data-client/vue';
import { EntityMap } from './resources';

export function useWebsocket(url: string) {
  const ctrl = useController();
  let ws: WebSocket;

  onMounted(() => {
    ws = new WebSocket(url);
    ws.onmessage = event => {
      const { entity, args, data } = JSON.parse(event.data);
      ctrl.set(EntityMap[entity], args, data);
    };
  });
  onUnmounted(() => ws?.close());
}

aviso

Em produção, implemente um Manager para streams de dados em vez de lifecycle hooks no nível do componente. Managers lidam com o ciclo de vida da conexão de forma global e funcionam com SSR.

Todo App

Explore o exemplo vue-todo-app

Abrir no StackBlitzVer código-fonte

Loading demo…

More Demos