this comme type

Le type this désigne l’objet sur lequel une méthode a été appelée, et le paramètre this décrit le contexte d’une fonction ordinaire.

Sur cette page

Exemple

#
TypeScript
class NotificationBuilder {
  protected parts: string[] = []

  title(text: string): this {
    this.parts.push(text.toUpperCase())
    return this
  }

  line(text: string): this {
    this.parts.push(text)
    return this
  }

  build(): string {
    return this.parts.join(' | ')
  }
}

class RewardNotification extends NotificationBuilder {
  exp(points: number): this {
    return this.line(`+${points} EXP`)
  }
}

const message = new RewardNotification().title('Tâche terminée').exp(20).line('Continuez comme ça !').build()
console.log(message)
Résultat
TÂCHE TERMINÉE | +20 EXP | Continuez comme ça !

Définition et utilisation

#

En position de type, le mot this désigne le type de l’objet sur lequel une méthode a été appelée. Une méthode dont le type de retour est this ne renvoie donc pas la classe où elle a été écrite, mais la classe de l’objet réel. Ainsi, une chaîne d’appels comme builder.title(…).line(…) conserve les méthodes des classes dérivées.

Le second usage est le paramètre this : un faux premier paramètre de fonction, par exemple function lessonLabel(this: Lesson, prefix: string). Vous ne le passez pas lors de l’appel, et il disparaît après la compilation. À la place, le compilateur vérifie que la fonction a été appelée avec le bon objet, par exemple via call() ou comme méthode d’un objet.

Le type this apparaît aussi dans les prédicats de méthode (isDone(): this is DoneTask) et dans les interfaces. Avec l’option noImplicitThis, qui fait partie du mode strict, utiliser this dans une fonction ordinaire sans type déclaré échoue avec l’erreur « 'this' implicitly has type 'any' because it does not have a type annotation ».

Syntaxe

#
Syntaxe
class Class {
  method(): this {
    return this
  }
}

function name(this: Type, arg: string) { … }

Plus d’exemples

#
Une méthode qui renvoie la classe de base
TypeScript
class PlainBuilder {
  line(text: string): PlainBuilder {
    return this
  }
}

class BadgeBuilder extends PlainBuilder {
  badge(name: string): BadgeBuilder {
    return this
  }
}

new BadgeBuilder().line('Bravo').badge('Série de 7 jours')
// Erreur : Property 'badge' does not exist on type 'PlainBuilder'.
Le paramètre this
TypeScript
interface Lesson {
  title: string
  minutes: number
}

function lessonLabel(this: Lesson, prefix: string): string {
  return `${prefix} ${this.title} (${this.minutes} min)`
}

const flexbox: Lesson = { title: 'Flexbox', minutes: 14 }
console.log(lessonLabel.call(flexbox, 'Leçon :'))

const grid = { title: 'Grid', minutes: 16, label: lessonLabel }
console.log(grid.label('Module :'))

// lessonLabel('Leçon :')
// Erreur : The 'this' context of type 'void' is not assignable to method's 'this' of type 'Lesson'.
Résultat
Leçon : Flexbox (14 min)
Module : Grid (16 min)

Bonnes pratiques

#
  • Typez les méthodes chaînables qui se terminent par return this avec : this, et non avec le nom de la classe. Ainsi, les classes dérivées ne perdent pas leurs méthodes au milieu de la chaîne.
  • Le paramètre this doit venir en premier dans la liste et ne compte pas comme un argument. Les fonctions fléchées n’ont pas de this propre, elles ne peuvent donc pas le déclarer : le compilateur signale « An arrow function cannot have a 'this' parameter ».
  • Pour un gestionnaire d’événement déclaré séparément qui utilise this, décrivez-le avec un paramètre : function onClick(this: HTMLButtonElement). En mode strict, utiliser this sans cette annotation est une erreur.

Entrées associées

#

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