added types for settings schema

playcanvas · Aug 13, 2024 · 51eda0a · 51eda0a
1 parent d263d06
commit 51eda0a
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/src/schema/settings.js b/src/schema/settings.js
@@ -17,6 +17,12 @@ class SettingsSchema {
         this._schema = this._schemaApi._schema.settings;
     }
 
+    /**
+     * @private
+     * @param {*} obj - The object to get the default data from
+     * @param {string} scope - The field scope
+     * @returns {*} - The default data
+     */
     _getDefaultData(obj, scope) {
         const result = {};
         for (const key in obj) {
@@ -38,14 +44,29 @@ class SettingsSchema {
         return result;
     }
 
+    /**
+     * Get the default settings for the project
+     *
+     * @returns {*} The default settings for the project
+     */
     getDefaultProjectSettings() {
         return this._getDefaultData(this._schema, 'project');
     }
 
+    /**
+     * Get the default settings for the user
+     *
+     * @returns {*} The default settings for the user
+     */
     getDefaultUserSettings() {
         return this._getDefaultData(this._schema, 'user');
     }
 
+    /**
+     * Get the default settings for the project user
+     *
+     * @returns {*} The default settings for the user in the project
+     */
     getDefaultProjectUserSettings() {
         return this._getDefaultData(this._schema, 'projectUser');
     }