npm - @redocly/config - Versions diffs - 0.15.0 → 0.17.0 - Mend

@redocly/config 0.15.0 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (25) hide show

package/lib/default-theme-config-schema.d.ts +738 -18
package/lib/ex-theme-config-schemas.d.ts +120 -0
package/lib/feedback-config-schema.d.ts +144 -0
package/lib/feedback-config-schema.js +20 -14
package/lib/graphql-config-schema.d.ts +120 -0
package/lib/portal-shared-types.d.ts +2 -0
package/lib/product-override-schema.d.ts +1200 -0
package/lib/redoc-config-schema.d.ts +120 -0
package/lib/reunite-config-schema.d.ts +9 -2
package/lib/reunite-config-schema.js +9 -1
package/lib/root-config-schema.d.ts +4006 -5
package/lib/types.d.ts +4 -0
package/lib-esm/default-theme-config-schema.d.ts +738 -18
package/lib-esm/ex-theme-config-schemas.d.ts +120 -0
package/lib-esm/feedback-config-schema.d.ts +144 -0
package/lib-esm/feedback-config-schema.js +19 -13
package/lib-esm/graphql-config-schema.d.ts +120 -0
package/lib-esm/portal-shared-types.d.ts +2 -0
package/lib-esm/product-override-schema.d.ts +1200 -0
package/lib-esm/redoc-config-schema.d.ts +120 -0
package/lib-esm/reunite-config-schema.d.ts +9 -2
package/lib-esm/reunite-config-schema.js +9 -1
package/lib-esm/root-config-schema.d.ts +4176 -175
package/lib-esm/types.d.ts +4 -0
package/package.json +1 -1

package/lib/default-theme-config-schema.d.ts CHANGED Viewed

@@ -635,6 +635,126 @@ export declare const themeConfigSchema: {
                         readonly reasons: {
                             readonly type: "object";
                             readonly properties: {
+                                readonly like: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly dislike: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly satisfied: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly neutral: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly dissatisfied: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
                                 readonly hide: {
                                     readonly type: "boolean";
                                     readonly default: false;
@@ -2384,6 +2504,126 @@ export declare const themeConfigSchema: {
                                 readonly reasons: {
                                     readonly type: "object";
                                     readonly properties: {
+                                        readonly like: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly dislike: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly satisfied: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly neutral: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly dissatisfied: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
                                         readonly hide: {
                                             readonly type: "boolean";
                                             readonly default: false;
@@ -2846,27 +3086,147 @@ export declare const themeConfigSchema: {
                                 readonly reasons: {
                                     readonly type: "object";
                                     readonly properties: {
-                                        readonly hide: {
-                                            readonly type: "boolean";
-                                            readonly default: false;
-                                        };
-                                        readonly component: {
-                                            readonly type: "string";
-                                            readonly enum: readonly ["radio", "checkbox"];
-                                            readonly default: "checkbox";
-                                        };
-                                        readonly label: {
-                                            readonly type: "string";
+                                        readonly like: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
                                         };
-                                        readonly items: {
-                                            readonly type: "array";
-                                            readonly items: {
-                                                readonly type: "string";
+                                        readonly dislike: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
                                             };
+                                            readonly additionalProperties: false;
                                         };
-                                    };
-                                    readonly additionalProperties: false;
-                                };
+                                        readonly satisfied: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly neutral: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly dissatisfied: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
                                 readonly comment: {
                                     readonly type: "object";
                                     readonly properties: {
@@ -4201,6 +4561,126 @@ export declare const closedThemeConfigSchema: {
                         readonly reasons: {
                             readonly type: "object";
                             readonly properties: {
+                                readonly like: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly dislike: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly satisfied: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly neutral: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly dissatisfied: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
                                 readonly hide: {
                                     readonly type: "boolean";
                                     readonly default: false;
@@ -5950,6 +6430,126 @@ export declare const closedThemeConfigSchema: {
                                 readonly reasons: {
                                     readonly type: "object";
                                     readonly properties: {
+                                        readonly like: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly dislike: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly satisfied: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly neutral: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly dissatisfied: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
                                         readonly hide: {
                                             readonly type: "boolean";
                                             readonly default: false;
@@ -6412,6 +7012,126 @@ export declare const closedThemeConfigSchema: {
                                 readonly reasons: {
                                     readonly type: "object";
                                     readonly properties: {
+                                        readonly like: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly dislike: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly satisfied: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly neutral: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
+                                        readonly dissatisfied: {
+                                            readonly type: "object";
+                                            readonly properties: {
+                                                readonly hide: {
+                                                    readonly type: "boolean";
+                                                    readonly default: false;
+                                                };
+                                                readonly component: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["radio", "checkbox"];
+                                                    readonly default: "checkbox";
+                                                };
+                                                readonly label: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly items: {
+                                                    readonly type: "array";
+                                                    readonly items: {
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                            };
+                                            readonly additionalProperties: false;
+                                        };
                                         readonly hide: {
                                             readonly type: "boolean";
                                             readonly default: false;