Accueil › Vue.js › Typer un composable et un store
Typer un composable et un store
Vue et TypeScriptavance
Un composable bien typé se reconnaît à deux choses : ce qu'il accepte en entrée, et ce qu'il annonce en sortie.
En entrée, une valeur peut arriver nue, dans une ref, ou derrière un accesseur.
MaybeRefOrGetter décrit les trois, et toValue les lit.
import { ref, computed, toValue, type MaybeRefOrGetter } from 'vue'
export function useFiltre(
elements: MaybeRefOrGetter<Produit[]>,
terme: MaybeRefOrGetter<string>,
) {
const resultats = computed(() =>
toValue(elements).filter((p) => p.nom.includes(toValue(terme))),
)
return { resultats }
}
L'appelant choisit : useFiltre(produits, () => props.recherche) ou
useFiltre(listeFigee, 'vue').
En sortie, le type se déduit de ce qu'on renvoie. L'annoter à la main n'est utile que pour verrouiller un contrat — par exemple pour garantir qu'un état reste en lecture seule.
Pour un store Pinia, la forme de mise en place se type toute seule.
export const usePanier = defineStore('panier', () => {
const lignes = ref<Ligne[]>([])
const total = computed(() => lignes.value.reduce((s, l) => s + l.prix, 0))
function ajouter(l: Ligne) { lignes.value.push(l) }
return { lignes, total, ajouter }
})
Le seul point qui demande une annotation explicite se trouve dans la forme à
options : un getter qui en lit un autre par this rend l'inférence circulaire,
et Pinia exige alors un type de retour écrit à la main.
Les termes à connaître
- Ref<T>
Le type d'une
ref.ref<string>('')produit unRef<string>;ref('')produit aussi unRef<string>, déduit de la valeur initiale.- ComputedRef<T>
Le type renvoyé par
computed. En lecture seule : affecter.valueest refusé, sauf pour uncomputeddéclaré avec un coupleget/set, dont le type estWritableComputedRef<T>.- MaybeRefOrGetter
Type utilitaire de
vuedécrivant « une valeur, uneref, ou une fonction qui la renvoie ». C'est la signature d'entrée recommandée pour un composable, lue ensuite avectoValue.- toValue
Déballe une valeur, une
refou un accesseur en une valeur simple. Introduit en Vue 3.3, il remplaceunrefdès qu'une fonction doit être acceptée en entrée.- InjectionKey<T>
Un
Symboltypé —const cle: InjectionKey<Panier> = Symbol()— qui relieprovideetinject. C'est le seul moyen d'obtenir uninjecttypé sans annotation au point d'appel.- Store de mise en place
Un store Pinia déclaré avec une fonction au lieu d'un objet d'options. Son typage est entièrement déduit de ce que la fonction renvoie.
- Getter autoréférent
Un getter d'un store d'options qui en lit un autre via
this. Pinia demande alors une annotation explicite du type de retour, sans quoi l'inférence devient circulaire.
Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.