Add type undefined to @type doctags

DevExpress · Nov 4, 2024 · 96772e3 · 96772e3
1 parent db2fdd1
commit 96772e3
Show file tree

Hide file tree

Showing 12 changed files with 19 additions and 19 deletions.
diff --git a/packages/devextreme/js/common.d.ts b/packages/devextreme/js/common.d.ts
@@ -758,7 +758,7 @@ export type TextEditorButton = {
   /**
    * @public
    * @docid
-   * @type dxButtonOptions
+   * @type dxButtonOptions | undefined
    * @default undefined
    */
   options?: ButtonProperties | undefined;

diff --git a/packages/devextreme/js/common/charts.d.ts b/packages/devextreme/js/common/charts.d.ts
@@ -251,7 +251,7 @@ export type VisualRange = {
     /**
     * @docid
     * @inherits VizTimeInterval
-    * @type number|object|Enums.TimeInterval
+    * @type number|object|Enums.TimeInterval|undefined
     * @default undefined
     * @public
     */

diff --git a/packages/devextreme/js/common/grids.d.ts b/packages/devextreme/js/common/grids.d.ts
@@ -719,7 +719,7 @@ export type ColumnHeaderFilter = {
    * @docid GridBaseColumn.headerFilter.dataSource
    * @type_function_param1_field component:object
    * @default undefined
-   * @type Array<any>|Store|DataSourceOptions|Function|null
+   * @type Array<any>|Store|DataSourceOptions|Function|null|undefined
    */
   dataSource?: FilterLookupDataSource<any> | ((options: { component?: any; dataSource?: DataSourceOptions | null }) => void) | undefined;
   /**
@@ -758,7 +758,7 @@ export type ColumnHeaderFilter = {
 export type ColumnHeaderFilterSearchConfig = HeaderFilterSearchConfig & {
   /**
    * @docid
-   * @type getter|Array<getter>
+   * @type getter|Array<getter>|undefined
    * @default undefined
    */
   searchExpr?: string | Function | Array<string | Function> | undefined;
@@ -779,7 +779,7 @@ export type ColumnLookup = {
    * @type_function_param1_field data:object
    * @default undefined
    * @type_function_return Array<any>|Store|DataSourceOptions
-   * @type Array<any>|Store|DataSourceOptions|Function|null
+   * @type Array<any>|Store|DataSourceOptions|Function|null|undefined
    */
   dataSource?: FilterLookupDataSource<any> | ((options: { data?: any; key?: any }) => FilterLookupDataSource<any>) | null | undefined;
   /**

diff --git a/packages/devextreme/js/ui/box.d.ts b/packages/devextreme/js/ui/box.d.ts
@@ -169,7 +169,7 @@ export interface dxBoxItem<TKey = any> extends CollectionWidgetItem {
      * @docid
      * @default undefined
      * @public
-     * @type dxBoxOptions
+     * @type dxBoxOptions | undefined
      */
     box?: dxBoxOptions<any, TKey> | undefined;
     /**

diff --git a/packages/devextreme/js/ui/data_grid.d.ts b/packages/devextreme/js/ui/data_grid.d.ts
@@ -1432,7 +1432,7 @@ export type dxDataGridOptions<TRowData = any, TKey = any> = Omit<GridBaseOptions
     summary?: Summary<TRowData, TKey>;
     /**
      * @docid
-     * @type dxDataGridToolbar
+     * @type dxDataGridToolbar | undefined
      * @default undefined
      * @public
      */

diff --git a/packages/devextreme/js/ui/defer_rendering.d.ts b/packages/devextreme/js/ui/defer_rendering.d.ts
@@ -90,7 +90,7 @@ export interface dxDeferRenderingOptions extends WidgetOptions<dxDeferRendering>
     onShown?: ((e: ShownEvent) => void);
     /**
      * @docid
-     * @type DxPromise|bool
+     * @type DxPromise|bool|undefined
      * @default undefined
      * @public
      */

diff --git a/packages/devextreme/js/ui/file_manager.d.ts b/packages/devextreme/js/ui/file_manager.d.ts
@@ -923,7 +923,7 @@ export interface dxFileManagerToolbarItem extends dxToolbarItem {
 export interface dxFileManagerDetailsColumn {
     /**
      * @docid
-     * @type Enums.HorizontalAlignment
+     * @type Enums.HorizontalAlignment | undefined
      * @default undefined
      * @acceptValues undefined
      * @public
@@ -967,7 +967,7 @@ export interface dxFileManagerDetailsColumn {
     sortIndex?: number | undefined;
     /**
      * @docid
-     * @type Enums.SortOrder
+     * @type Enums.SortOrder | undefined
      * @default undefined
      * @acceptValues undefined
      * @public

diff --git a/packages/devextreme/js/ui/filter_builder.d.ts b/packages/devextreme/js/ui/filter_builder.d.ts
@@ -508,7 +508,7 @@ export interface dxFilterBuilderField {
       /**
        * @docid
        * @default undefined
-       * @type Array<any> | Store | DataSourceOptions
+       * @type Array<any> | Store | DataSourceOptions | undefined
        */
       dataSource?: FilterLookupDataSource<any> | null | undefined;
       /**

diff --git a/packages/devextreme/js/ui/splitter.d.ts b/packages/devextreme/js/ui/splitter.d.ts
@@ -244,7 +244,7 @@ export interface dxSplitterItem<TKey = any> extends CollectionWidgetItem {
      * @docid
      * @default undefined
      * @public
-     * @type dxSplitterOptions
+     * @type dxSplitterOptions | undefined
      */
     splitter?: Properties<any, TKey> | undefined;
     /**

diff --git a/packages/devextreme/js/ui/tree_list.d.ts b/packages/devextreme/js/ui/tree_list.d.ts
@@ -1140,7 +1140,7 @@ export type dxTreeListOptions<TRowData = any, TKey = any> = Omit<GridBaseOptions
     selection?: Selection;
     /**
      * @docid
-     * @type dxTreeListToolbar
+     * @type dxTreeListToolbar | undefined
      * @default undefined
      * @public
      */

diff --git a/packages/devextreme/js/viz/chart.d.ts b/packages/devextreme/js/viz/chart.d.ts
@@ -1427,12 +1427,12 @@ export type ArgumentAxis = CommonAxisSettings & {
     /**
      * @docid dxChartOptions.argumentAxis.minVisualRangeLength
      * @inherits VizTimeInterval
-     * @type number|object|Enums.TimeInterval
+     * @type number|object|Enums.TimeInterval|undefined
      * @default undefined
      * @notUsedInTheme
      * @public
      */
-    minVisualRangeLength?: TimeIntervalConfig | undefined;
+    minVisualRangeLength?: TimeIntervalConfig;
     /**
      * @docid dxChartOptions.argumentAxis.minorTickCount
      * @default undefined
@@ -2522,12 +2522,12 @@ export type ValueAxis = CommonAxisSettings & {
     /**
      * @docid dxChartOptions.valueAxis.minVisualRangeLength
      * @inherits VizTimeInterval
-     * @type number|object|Enums.TimeInterval
+     * @type number|object|Enums.TimeInterval|undefined
      * @default undefined
      * @notUsedInTheme
      * @public
      */
-    minVisualRangeLength?: TimeIntervalConfig | undefined;
+    minVisualRangeLength?: TimeIntervalConfig;
     /**
      * @docid dxChartOptions.valueAxis.minorTickCount
      * @default undefined

diff --git a/packages/devextreme/js/viz/polar_chart.d.ts b/packages/devextreme/js/viz/polar_chart.d.ts
@@ -1290,12 +1290,12 @@ export type ValueAxis = CommonAxisSettings & {
     /**
      * @docid dxPolarChartOptions.valueAxis.minVisualRangeLength
      * @inherits VizTimeInterval
-     * @type number|object|Enums.TimeInterval
+     * @type number|object|Enums.TimeInterval|undefined
      * @default undefined
      * @notUsedInTheme
      * @public
      */
-    minVisualRangeLength?: TimeIntervalConfig | undefined;
+    minVisualRangeLength?: TimeIntervalConfig;
     /**
      * @docid dxPolarChartOptions.valueAxis.minorTickCount
      * @default undefined