Răsfoiți Sursa

Docs: Added `CloudServicesConfig#bundleVersion` to the documentation.

Szymon Cofalik 6 ani în urmă
părinte
comite
ae60daa552
1 a modificat fișierele cu 9 adăugiri și 0 ștergeri
  1. 9 0
      packages/ckeditor5-cloud-services/src/cloudservices.js

+ 9 - 0
packages/ckeditor5-cloud-services/src/cloudservices.js

@@ -186,6 +186,15 @@ CloudServices.Token = Token;
  * @member {String} module:cloud-services/cloudservices~CloudServicesConfig#webSocketUrl
  */
 
+/**
+ * Optional parameter used for integration with Cloud Services, when uploading the editor build to Cloud Services.
+ *
+ * Whenever the editor build or the configuration changes, this parameter should be set to a new, unique value, to differentiate
+ * the new bundle (build + configuration) from the old ones.
+ *
+ * @member {String} module:cloud-services/cloudservices~CloudServicesConfig#bundleVersion
+ */
+
 /**
  * Document ID, used by the `RealTimeCollaborativeEditing` plugin. All editor instances created with the same document ID will collaborate.
  * It means that each document needs a different document ID if you do not want to start collaboration between these documents.