ReadonlyArray<Type>

Un tableau en lecture seule : sans push, sort ni affectation par index.

Sur cette page

Exemple
Définition et utilisation
Syntaxe
Paramètres de type
Plus d’exemples
Bonnes pratiques
Entrées associées

Exemple

TypeScript

function topScores(scores: ReadonlyArray<number>, count: number): number[] {
  return [...scores].sort((a, b) => b - a).slice(0, count)
}

const results: ReadonlyArray<number> = [72, 95, 64, 88]
console.log(topScores(results, 2))
console.log(results)

Résultat

[95, 88]
[72, 95, 64, 88]

Définition et utilisation

ReadonlyArray<Type> décrit un tableau qui ne peut pas être modifié. Il n’a aucune méthode de modification comme push, pop, splice, sort ou reverse, et une affectation comme scores[0] = … se termine par une erreur. Restent les méthodes qui se contentent de lire ou de créer un nouveau tableau : map, filter, slice, includes, join.

Une notation plus courte et équivalente est readonly Type[], et c’est justement ainsi que le compilateur affiche ce type dans ses messages. Choisissez un seul style pour votre projet. ReadonlyArray est parfois plus lisible avec des éléments complexes, par ex. ReadonlyArray<string | number> plutôt que readonly (string | number)[].

Un tableau ordinaire peut être transmis là où un tableau en lecture seule est attendu, mais pas l’inverse. Un paramètre de type ReadonlyArray<T> est donc une promesse : la fonction acceptera n’importe quel tableau et n’y changera rien. La protection n’agit qu’à la compilation ; dans le programme en cours d’exécution, c’est un tableau ordinaire.

Syntaxe

const list: ReadonlyArray<Type> = […]
const list2: readonly Type[] = […]

Paramètres de type

Type
type quelconque
Le type des éléments du tableau.

Paramètre	Type	Description
Type	type quelconque	Le type des éléments du tableau.

Plus d’exemples

Des changements bloqués

TypeScript

function resetFirst(scores: ReadonlyArray<number>) {
  scores[0] = 0
  // Erreur : Index signature in type 'readonly number[]' only permits reading.
  scores.sort()
  // Erreur : Property 'sort' does not exist on type 'readonly number[]'.
}

La transmission à une fonction qui modifie le tableau

TypeScript

function addBonus(scores: number[]) {
  scores.push(10)
}

addBonus(results)
// Erreur : Argument of type 'readonly number[]' is not assignable to parameter of type 'number[]'.
//   The type 'readonly number[]' is 'readonly' and cannot be assigned to the mutable type 'number[]'.

Bonnes pratiques

Typez les paramètres comme ReadonlyArray<T> si la fonction ne modifie pas le tableau. Elle acceptera alors aussi des tableaux en lecture seule, par exemple des constantes créées avec as const.
Pour trier sans muter, utilisez une copie [...list].sort() ou la méthode toSorted(), qui nécessite la version ES2023 dans lib.
ReadonlyArray fonctionne de façon superficielle : les objets du tableau restent modifiables. Pour bloquer aussi leurs champs, utilisez ReadonlyArray<Readonly<T>>.

Entrées associées

Vous voyez une erreur ou il manque un exemple ? Écrivez-nous.

Leçons gratuitesPratiquez TypeScript dans le cours JavaScript et TypeScriptDes exercices avec indices, un éditeur de code et une progression enregistrée au fur et à mesure.Voir le cours