Description |
Description |
---|---|
Postman |
Description
Cette classe contient la description d'une propriété.
Liste des méthodes
Nom | Syntaxe | Description |
---|---|---|
DESCRIPTION | new Description(definition opt) | Ce constructeur permet de créer l'objet. Il s'agit de l'une des propriétés étant (si fournies) traitées par toutes les autres propriétés. Toute propriété peut avoir une instance de la propriété Description qui lui est assignée avec la description du nom de clé et elle doit être traitée comme quelque chose qui « décrit » la propriété à laquelle elle appartient. Habituellement, cette propriété est utilisée pour générer de la documentation et d'autres informations contextuelles pour une propriété dans une collection. |
ISDESCRIPTION | isDescription(obj) → {Boolean} | Cette méthode permet de vérifier si une propriété est une instance de l'objet Description. |
TOJSON | toJSON() → {Object} | Cette méthode permet de créer une représentation JSON de la description (en tant qu'objet JavaScript simple). |
TOSTRING | toString() → {String} | Cette méthode permet de retourner la description sous forme de chaîne de caractères. |
UPDATE | update(content, typeopt) | Cette méthode permet de mettre à jour le contenu de cette propriété de description. |
Dernière mise à jour : Vendredi, le 27 janvier 2023