Class Graph

constructor

• new Graph(__namedParameters?: GraphValues): Graph

  Constructeur minimaliste, qui peut générer un graphe vide invalide (il faudra appeler add puis validate)

  Parameters

  • __namedParameters: GraphValues = {}

  Returns Graph

nodes

startingId

addEndNodeAsLastConnexion

• addEndNodeAsLastConnexion(node: GraphNode): GraphNode

  Ajoute un nœud fin sur node, comme dernier branchement sans condition (décalé en x)

  Parameters

  • node: GraphNode

  Returns GraphNode

addNode

• addNode(node: GraphNodeValues): GraphNode

  Ajoute un node au graphe

  Parameters

  • node: GraphNodeValues

  Returns GraphNode

  le node ajouté (avec id complété ou modifié si besoin)

checkStartingId

• checkStartingId(messages: string[]): void

  Vérifie que startingId correspond à un nœud existant (sinon le vide). Ensuite, si startingId est vide et qu'il y a un seul nœud non-fin, alors il est mis dans startingId

  Parameters

  • messages: string[]

  Returns void

complete

• complete(__namedParameters?: { emptyAllowed?: boolean }): string

  Complète le graphe

  • ajoute un nœud fin s’il n’y en a pas
  • sur chaque branchement, si le dernier branchement n’est pas sans condition, en ajoute un vers un nœud fin
  • si startingId est vide on prend le nœud non fin qui n'est pas cible d'autre nœuds (sinon le premier)

  Parameters

  • __namedParameters: { emptyAllowed?: boolean } = {}

  Returns string

  Un message listant les problèmes éventuels, avec l’ajout du nœud fin éventuel, destiné à l’utilisateur qui édite (séparateur \n)

  Throws

  s’il n’y a aucun nœud avec (sans emptyAllowed)

getLength

• getLength(): number

  Retourne le nombre de nœuds "non fin"

  Returns number

getNode

• getNode(nodeId: string): GraphNode

  Retourne un nœud du graphe

  Parameters

  • nodeId: string

  Returns GraphNode

  Throws

  s’il n’y a pas de nœud avec cet id dans le graphe

serialize

• serialize(): GraphSerialized

  Returns GraphSerialized

setStartingId

• setStartingId(startingId: string): void

  Affecte le nœud de départ du graphe

  Parameters

  • startingId: string

  Returns void

toJSON

• toJSON(): GraphJson

  Returns GraphJson

validate

• validate(options?: GraphValidateOpts): Promise<CheckResults>

  Valide le graphe (version complète async qui vérifie les pe)

  Parameters

  • Optionaloptions: GraphValidateOpts = {}

    • Optionalclean?: boolean

    • OptionalemptyAllowed?: boolean

    • Optionalstrict?: boolean

  Returns Promise<CheckResults>

  Message éventuel à propos du nettoyage effectué

  Throws

  si y’a un pb

validateSync

• validateSync(options?: GraphValidateOpts): CheckResults

  Valide le graphe (version light mais sync, qui vérifie la structure pas la validité des pe)

  Parameters

  • Optionaloptions: GraphValidateOpts = {}

    • Optionalclean?: boolean

    • OptionalemptyAllowed?: boolean

    • Optionalstrict?: boolean

  Returns CheckResults