Browse Source

types: Allow event handlers to return undefined

Nathan Walters 3 years ago
parent
commit
e194d04cb9
1 changed files with 29 additions and 29 deletions
  1. 29 29
      index.d.ts

+ 29 - 29
index.d.ts

@@ -158,38 +158,38 @@ interface BootstrapAjaxParams{
 }
 }
 
 
 interface BootstrapTableOptions{
 interface BootstrapTableOptions{
-    onCheck?: (row: any, $element: JQuery<HTMLElement>) => boolean;
+    onCheck?: (row: any, $element: JQuery<HTMLElement>) => boolean | undefined;
     loadingFontSize?: string;
     loadingFontSize?: string;
-    onDblClickCell?: (field: string, value: any, row: any, $element: JQuery<HTMLElement>) => boolean;
+    onDblClickCell?: (field: string, value: any, row: any, $element: JQuery<HTMLElement>) => boolean | undefined;
     rowStyle?: (row: any, index: number) => {};
     rowStyle?: (row: any, index: number) => {};
     showColumnsToggleAll?: boolean;
     showColumnsToggleAll?: boolean;
     footerStyle?: (column: BootstrapTableColumn) => {};
     footerStyle?: (column: BootstrapTableColumn) => {};
-    onUncheck?: (row: any, $element: JQuery<HTMLElement>) => boolean;
+    onUncheck?: (row: any, $element: JQuery<HTMLElement>) => boolean | undefined;
     pageSize?: number;
     pageSize?: number;
     footerField?: string;
     footerField?: string;
     showFullscreen?: boolean;
     showFullscreen?: boolean;
     sortStable?: boolean;
     sortStable?: boolean;
     searchAlign?: string;
     searchAlign?: string;
     ajax?: (params: BootstrapAjaxParams) => any;
     ajax?: (params: BootstrapAjaxParams) => any;
-    onAll?: (name: string, args: any) => boolean;
-    onClickRow?: (row: any, $element: JQuery<HTMLElement>, field: string) => boolean;
+    onAll?: (name: string, args: any) => boolean | undefined;
+    onClickRow?: (row: any, $element: JQuery<HTMLElement>, field: string) => boolean | undefined;
     ajaxOptions?: {};
     ajaxOptions?: {};
-    onCheckSome?: (rows: any[]) => boolean;
+    onCheckSome?: (rows: any[]) => boolean | undefined;
     customSort?: any;
     customSort?: any;
     iconSize?: any;
     iconSize?: any;
-    onCollapseRow?: (index: number, row: any, detailView: any) => boolean;
+    onCollapseRow?: (index: number, row: any, detailView: any) => boolean | undefined;
     searchHighlight?: boolean;
     searchHighlight?: boolean;
     height?: any;
     height?: any;
-    onUncheckSome?: (rows: any[]) => boolean;
-    onToggle?: (cardView: boolean) => boolean;
+    onUncheckSome?: (rows: any[]) => boolean | undefined;
+    onToggle?: (cardView: boolean) => boolean | undefined;
     ignoreClickToSelectOn?: ({tagName}?: {tagName: any}) => any;
     ignoreClickToSelectOn?: ({tagName}?: {tagName: any}) => any;
     cache?: boolean;
     cache?: boolean;
     method?: string;
     method?: string;
-    onColumnSwitch?: (field: string, checked: boolean) => boolean;
+    onColumnSwitch?: (field: string, checked: boolean) => boolean | undefined;
     searchSelector?: boolean;
     searchSelector?: boolean;
     strictSearch?: boolean;
     strictSearch?: boolean;
     multipleSelectRow?: boolean;
     multipleSelectRow?: boolean;
-    onLoadError?: (status: string, jqXHR: JQuery.jqXHR) => boolean;
+    onLoadError?: (status: string, jqXHR: JQuery.jqXHR) => boolean | undefined;
     buttonsToolbar?: any;
     buttonsToolbar?: any;
     paginationVAlign?: string;
     paginationVAlign?: string;
     showColumnsSearch?: boolean;
     showColumnsSearch?: boolean;
@@ -201,9 +201,9 @@ interface BootstrapTableOptions{
     showButtonText?: boolean;
     showButtonText?: boolean;
     sortName?: any;
     sortName?: any;
     columns?: BootstrapTableColumn[];
     columns?: BootstrapTableColumn[];
-    onScrollBody?: () => boolean;
+    onScrollBody?: () => boolean | undefined;
     iconsPrefix?: string;
     iconsPrefix?: string;
-    onPostBody?: () => boolean;
+    onPostBody?: () => boolean | undefined;
     search?: boolean;
     search?: boolean;
     searchOnEnterKey?: boolean;
     searchOnEnterKey?: boolean;
     searchText?: string;
     searchText?: string;
@@ -217,42 +217,42 @@ interface BootstrapTableOptions{
     buttonsAlign?: string;
     buttonsAlign?: string;
     buttonsOrder?: string[];
     buttonsOrder?: string[];
     detailFormatter?: (index: number, row: any, $element: JQuery<HTMLElement>) => string;
     detailFormatter?: (index: number, row: any, $element: JQuery<HTMLElement>) => string;
-    onDblClickRow?: (row: any, $element: JQuery<HTMLElement>, field: string) => boolean;
+    onDblClickRow?: (row: any, $element: JQuery<HTMLElement>, field: string) => boolean | undefined;
     paginationNextText?: string;
     paginationNextText?: string;
     buttonsPrefix?: string;
     buttonsPrefix?: string;
     loadingTemplate?: (loadingMessage: string) => string;
     loadingTemplate?: (loadingMessage: string) => string;
     theadClasses?: string;
     theadClasses?: string;
-    onLoadSuccess?: (data: any, status: string, jqXHR: JQuery.jqXHR) => boolean;
+    onLoadSuccess?: (data: any, status: string, jqXHR: JQuery.jqXHR) => boolean | undefined;
     url?: any;
     url?: any;
     toolbar?: any;
     toolbar?: any;
-    onPostHeader?: () => boolean;
+    onPostHeader?: () => boolean | undefined;
     sidePagination?: string;
     sidePagination?: string;
     clickToSelect?: boolean;
     clickToSelect?: boolean;
     virtualScrollItemHeight?: any;
     virtualScrollItemHeight?: any;
     rowAttributes?: (row: any, index: number) => {};
     rowAttributes?: (row: any, index: number) => {};
     dataField?: string;
     dataField?: string;
     idField?: string;
     idField?: string;
-    onSort?: (name: string, order: number) => boolean;
+    onSort?: (name: string, order: number) => boolean | undefined;
     pageNumber?: number;
     pageNumber?: number;
     data?: any[];
     data?: any[];
     totalNotFilteredField?: string;
     totalNotFilteredField?: string;
     undefinedText?: string;
     undefinedText?: string;
-    onSearch?: (text: string) => boolean;
-    onPageChange?: (number: number, size: number) => boolean;
+    onSearch?: (text: string) => boolean | undefined;
+    onPageChange?: (number: number, size: number) => boolean | undefined;
     paginationUseIntermediate?: boolean;
     paginationUseIntermediate?: boolean;
     searchAccentNeutralise?: boolean;
     searchAccentNeutralise?: boolean;
     singleSelect?: boolean;
     singleSelect?: boolean;
     showButtonIcons?: boolean;
     showButtonIcons?: boolean;
     showPaginationSwitch?: boolean;
     showPaginationSwitch?: boolean;
-    onPreBody?: (data: any) => boolean;
-    detailFilter?: (index: number, row: any) => boolean;
+    onPreBody?: (data: any) => boolean | undefined;
+    detailFilter?: (index: number, row: any) => boolean | undefined;
     detailViewByClick?: boolean;
     detailViewByClick?: boolean;
     totalField?: string;
     totalField?: string;
     contentType?: string;
     contentType?: string;
     showColumns?: boolean;
     showColumns?: boolean;
     totalNotFiltered?: number;
     totalNotFiltered?: number;
     checkboxHeader?: boolean;
     checkboxHeader?: boolean;
-    onRefresh?: (params: any[]) => boolean;
+    onRefresh?: (params: any[]) => boolean | undefined;
     dataType?: string;
     dataType?: string;
     paginationPreText?: string;
     paginationPreText?: string;
     showToggle?: boolean;
     showToggle?: boolean;
@@ -260,13 +260,13 @@ interface BootstrapTableOptions{
     serverSort?: boolean;
     serverSort?: boolean;
     totalRows?: number;
     totalRows?: number;
     silentSort?: boolean;
     silentSort?: boolean;
-    onPostFooter?: () => boolean;
+    onPostFooter?: () => boolean | undefined;
     selectItemName?: string;
     selectItemName?: string;
     detailViewIcon?: boolean;
     detailViewIcon?: boolean;
     detailViewAlign?: string;
     detailViewAlign?: string;
     minimumCountColumns?: number;
     minimumCountColumns?: number;
     uniqueId?: any;
     uniqueId?: any;
-    onResetView?: () => boolean;
+    onResetView?: () => boolean | undefined;
     paginationHAlign?: string;
     paginationHAlign?: string;
     sortClass?: any;
     sortClass?: any;
     pagination?: boolean;
     pagination?: boolean;
@@ -278,25 +278,25 @@ interface BootstrapTableOptions{
     trimOnSearch?: boolean;
     trimOnSearch?: boolean;
     showRefresh?: boolean;
     showRefresh?: boolean;
     locale?: BootstrapTableLocale;
     locale?: BootstrapTableLocale;
-    onCheckAll?: (rowsAfter: any[], rowsBefore: any[]) => boolean;
+    onCheckAll?: (rowsAfter: any[], rowsBefore: any[]) => boolean | undefined;
     showFooter?: boolean;
     showFooter?: boolean;
     headerStyle?: (column: BootstrapTableColumn) => {};
     headerStyle?: (column: BootstrapTableColumn) => {};
     maintainMetaData?: boolean;
     maintainMetaData?: boolean;
-    onRefreshOptions?: (options: BootstrapTableOptions) => boolean;
+    onRefreshOptions?: (options: BootstrapTableOptions) => boolean | undefined;
     showExtendedPagination?: boolean;
     showExtendedPagination?: boolean;
     smartDisplay?: boolean;
     smartDisplay?: boolean;
     paginationLoop?: boolean;
     paginationLoop?: boolean;
     virtualScroll?: boolean;
     virtualScroll?: boolean;
     sortReset?: boolean;
     sortReset?: boolean;
     filterOptions?: {filterAlgorithm: string};
     filterOptions?: {filterAlgorithm: string};
-    onUncheckAll?: (rowsAfter: any[], rowsBefore: any[]) => boolean;
+    onUncheckAll?: (rowsAfter: any[], rowsBefore: any[]) => boolean | undefined;
     showSearchClearButton?: boolean;
     showSearchClearButton?: boolean;
     buttons?: {};
     buttons?: {};
     showHeader?: boolean;
     showHeader?: boolean;
-    onClickCell?: (field: string, value: any, row: any, $element: JQuery<HTMLElement>) => boolean;
+    onClickCell?: (field: string, value: any, row: any, $element: JQuery<HTMLElement>) => boolean | undefined;
     sortable?: boolean;
     sortable?: boolean;
     icons?: BootstrapTableIcons;
     icons?: BootstrapTableIcons;
-    onExpandRow?: (index: number, row: any, $detail: JQuery<HTMLElement>) => boolean;
+    onExpandRow?: (index: number, row: any, $detail: JQuery<HTMLElement>) => boolean | undefined;
     buttonsClass?: string;
     buttonsClass?: string;
     pageList?: number[];
     pageList?: number[];
 }
 }