Przeglądaj źródła

Updated docs for the `Watchdog#state`.

Maciej Bukowski 6 lat temu
rodzic
commit
46650d13cb
1 zmienionych plików z 7 dodań i 1 usunięć
  1. 7 1
      packages/ckeditor5-watchdog/src/watchdog.js

+ 7 - 1
packages/ckeditor5-watchdog/src/watchdog.js

@@ -42,7 +42,13 @@ export default class Watchdog {
 		this.crashes = [];
 
 		/**
-		 * Specifies the watchdog state.
+		 * Specifies the state of the editor handled by the watchdog. The state can be one of the following values:
+		 *
+		 * * `initializing` - before the first initialization, and after crashes, before the editor is ready.
+		 * * `ready` - a state when a user can interact with the editor
+		 * * `crashed` - a state when an error occurs - it quickly changes to `initializing` or `crashedPernamently`
+		 * depending on how many and how frequency errors have been caught recently.
+		 * * `crashedPernamently` - a state when the watchdog stops reacting to errors and keeps the editor crashed.
 		 *
 		 * @public
 		 * @observable