requireTextOutput

function requireTextOutput(
  value: unknown,
  message: string = "Expected a TextOutput object."
): TextOutput;

Un objet de service Apps Script n'a pas de constructeur contre lequel un script pourrait tester, alors le garde cherche les méthodes qui définissent le type — getMimeType, getContent. Un bouchon qui les implémente passe, et c'est ce qui rend ce code testable hors de l'environnement d'exécution.

isX et nonX répondent à une question sans jamais interrompre le flot ; requireX et requireNonX rendent la valeur ou lèvent. Le schéma est expliqué dans Conventions de validation.

Paramètres

Paramètre	Type	Description
`value`	`unknown`	La valeur à valider.
`message` (facultatif) `= "Expected a TextOutput object."`	`string`	Le message de l'exception. À défaut, un message par défaut est utilisé.

Valeur de retour

TextOutput — la même valeur, typée comme un TextOutput.

Exceptions

Exception	Condition
`IllegalArgumentException`	la valeur n'est pas un TextOutput.

Exemples

Ce qui passe et ce qui ne passe pas

const output = ContentService.createTextOutput("hi");

requireTextOutput(output); // => output
requireTextOutput({}); // throws IllegalArgumentException
requireTextOutput(null); // throws IllegalArgumentException

Voir aussi

Code source

src/appsscript/ui/requireTextOutput.ts

23 September 2026

Cette documentation a été générée par une IA (Claude) à partir du code source de la bibliothèque.