Share: document the future state machine

MichaelMure · Jul 19, 2017 · 9e41ca4 · 9e41ca4
1 parent 2aa11fd
commit 9e41ca4
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/app/models/Share.js b/app/models/Share.js
@@ -19,6 +19,28 @@ export const ShareState = {
 }
 export type ShareStateType = $Keys<typeof ShareState>
 
+/**
+ * PlantUML diagram (http://plantuml.com/state-diagram)
+ *
+ * @startuml
+ *
+ * [*] --> Available : got a notification
+ *
+ * Available --> Downloading : start()
+ * Downloading --> Available : abort()
+ *
+ * Downloading --> Paused : pause()
+ * Paused --> Downloading : start()
+ *
+ * Paused --> Available : abort()
+ *
+ * [*] --> Sharing : created a Share locally
+ *
+ * Downloading --> Sharing : download done
+ *
+ * @enduml
+ */
+
 export const writable = {
   dataVersion: 'dataVersion',
   id: 'id',