$doc.getStatesModel¶

Description¶

Retourne une description du modèle d'état d'un dossier.

Syntaxe¶

$doc.getStatesModel( [ context [ , options ] ] )

Paramètres¶

context string / map

Object décrivant le contexte du dossier à traiter. Le paramètre peut désigner soit un contexte (exprimé en tant que string en clair, p.ex. "listeArticle[123]" ou sous forme de hash) ou un map décrivant le contexte. Dans ce cas, le map doit a minima contenir une valeur pour l'entrée modelName.

Si non spécifié, le moteur reprend le contexte courant.

options map

Options décrivant le type de réponse attendue. Les options reconnues sont:

format string

Format du modèle d'états à retourner. Les formats supportés sont:

• default : génère un map décrivant le modèle d'état correspondant au contexte reçu
• mermaid : génère une représentation des états au format mermaid.js

transitionNames boolean

Flag indiquant de reprendre les noms de transitions dans le graph

Retour¶

Retourne un objet décrivant le modèle d'état. Le format de sortie dépend de l'option format indiquée.

Exemple¶

Non disponible