datatables.net 3.0.0 → 3.0.2

package/types/types.d.ts

@@ -1,4 +1,4 @@
-/*! DataTables
+/*! DataTables 3.0.2
  * Copyright (c) SpryMedia Ltd - datatables.net/license
  */
 
@@ -91,7 +91,7 @@ declare class Dom<T extends HTMLElement = HTMLElement> implements ArrayLike<T> {
     /**
      * Add an element (or multiple) to the instance. Will ensure uniqueness.
      *
-     * @param el Element(s) to add
+     * @param selector Element(s) to add
      * @param sort Indicate if the element should be added in document order.
      * @returns Self for chaining
      */
@@ -330,7 +330,7 @@ declare class Dom<T extends HTMLElement = HTMLElement> implements ArrayLike<T> {
     /**
      * Get all matching descendants
      *
-     * @param selector Elements to find
+     * @param input Elements to find
      * @returns A new Dom instance with all matching elements
      */
     find<R extends HTMLElement = T>(input: Dom | string | HTMLElement | Element | null): Dom<R>;
@@ -1222,9 +1222,9 @@ type LayoutElement = {
 };
 type LayoutComponent = LayoutElement | LayoutFeatures | (() => HTMLElement) | HTMLElement | JQuery<HTMLElement> | Dom | null;
 type Layout = Partial<Record<LayoutKeys, LayoutComponent>>;
-type FunctionColumnRender = (this: DataTableDom, data: any, type: any, row: any, meta: CellMetaSettings) => any;
+type ColumnRenderFunction = (this: DataTableDom, data: any, type: any, row: any, meta: CellMeta) => any;
 type FunctionColumnCreatedCell = (this: DataTableDom, cell: HTMLTableCellElement, cellData: any, rowData: any, row: number, col: number) => void;
-interface CellMetaSettings {
+interface CellMeta {
     row: number;
     col: number;
     settings: Context;
@@ -1248,8 +1248,8 @@ interface OrderFixed {
     post?: any[];
 }
 interface FunctionColumnData {
-    (row: any, type: 'set', s: any, meta: CellMetaSettings): void;
-    (row: any, type: 'display' | 'sort' | 'filter' | 'type', s: undefined, meta: CellMetaSettings): any;
+    (row: any, type: 'set', s: any, meta: CellMeta): void;
+    (row: any, type: 'display' | 'sort' | 'filter' | 'type', s: undefined, meta: CellMeta): any;
 }
 interface ObjectColumnData {
     _: string | number | FunctionColumnData;
@@ -1259,11 +1259,11 @@ interface ObjectColumnData {
     sort?: string | number | FunctionColumnData;
 }
 interface ObjectColumnRender {
-    _?: string | number | FunctionColumnRender;
-    filter?: string | number | FunctionColumnRender;
-    display?: string | number | FunctionColumnRender;
-    type?: string | number | FunctionColumnRender;
-    sort?: string | number | FunctionColumnRender;
+    _?: string | number | ColumnRenderFunction;
+    filter?: string | number | ColumnRenderFunction;
+    display?: string | number | ColumnRenderFunction;
+    type?: string | number | ColumnRenderFunction;
+    sort?: string | number | ColumnRenderFunction;
 }
 interface AjaxData {
     draw?: number;
@@ -1411,7 +1411,7 @@ interface Defaults$1 {
     /**
      * Render (process) the data for use in the table.
      */
-    render: number | string | ObjectColumnData | FunctionColumnRender | ObjectColumnRender | null;
+    render: number | string | ObjectColumnData | ColumnRenderFunction | ObjectColumnRender | null;
     search: SearchOptions | null;
     /**
      * Enable or disable filtering on the data in this column.
@@ -1562,7 +1562,7 @@ interface Defaults {
      * Add event listeners during the DataTables startup
      */
     on: {
-        [name: string]: (this: HTMLElement, e: Event, ...args: any[]) => void;
+        [name: string]: (this: HTMLElement, e: DataTableEvent, ...args: any[]) => void;
     };
     /**
      * Initial order (sort) to apply to the table.
@@ -1728,6 +1728,8 @@ interface Defaults {
     tabIndex: number;
     /** Specify which row is the title row in the header. */
     titleRow: null | number | boolean;
+    /** Ability to enable / disable auto type detection. */
+    typeDetect: boolean;
 }
 type LanguageOption = string | {
     [key: string | number]: LanguageOption;
@@ -2354,6 +2356,7 @@ type RegisterCallback<T> = (settings: Context, options: T) => HTMLElement | Dom
  * @param name The name of the new feature.
  * @param cb A function that will create the elements and event listeners for
  * the feature being added.
+ * @param legacyChar
  */
 declare function register$1<T>(name: string, cb: RegisterCallback<T>, legacyChar?: string): void;
 
@@ -2638,6 +2641,7 @@ declare function pluck(a: any[], prop: string | number, prop2?: string | number)
  * as the indexes to pick from the source array
  *
  * @param a Array to get values from
+ * @param order Indexes to pick
  * @param prop Property to read values from
  * @param prop2 Inner property to get values from if a 2D array
  * @returns Array of read values
@@ -2952,7 +2956,7 @@ declare function escapeHtml<T>(mixed: T): T;
 /**
  * Set the function to use for HTML entity encoding from a string
  *
- * @param fn HTML escape function
+ * @param mixed HTML escape function
  */
 declare function escapeHtml<T = TEscapeHtml>(mixed: T): void;
 /**
@@ -2968,13 +2972,14 @@ declare function normalize(mixed: string, both?: boolean): string;
 /**
  * Set the function to use for string normalisation
  *
- * @param mixed Normalisation function
+ * @param fn Normalisation function
  */
 declare function normalize<T = TNormalize>(fn: T): void;
 /**
  * Strip HTML from a string, if a string is given, otherwise no action
  *
  * @param mixed Value to remove HTML from
+ * @param replacement
  * @returns The stripped value (or original if not a string)
  */
 declare function stripHtml<T>(mixed: T, replacement?: string): T;
@@ -3002,7 +3007,7 @@ declare namespace string {
  * Debounce a function
  *
  * @param fn Function to be called
- * @param timeout Call frequency in mS
+ * @param freq Call frequency in mS
  * @returns Wrapped function
  */
 declare function debounce(fn: () => void, freq?: number): () => void;
@@ -3117,6 +3122,9 @@ type HeaderStructure = {
     rowspan: number;
     title: string;
 };
+interface DataTableEvent<T = any> extends Event {
+    dt: Api<T>;
+}
 interface ApiConstructor {
     new (content: InstSelector, data?: any): Api;
     (content: InstSelector, data?: any): Api;
@@ -3424,7 +3432,7 @@ interface ApiScopeable<T, S> {
      * unbind a single event listener.
      * @returns DataTables Api instance
      */
-    off(event: string, callback?: (this: HTMLElement, e: Event, ...args: any[]) => void): Api<T>;
+    off(event: string, callback?: (this: HTMLElement, e: DataTableEvent, ...args: any[]) => void): Api<T>;
     /**
      * Remove event handlers from selected elements
      *
@@ -3434,7 +3442,7 @@ interface ApiScopeable<T, S> {
      * unbind a single event listener.
      * @returns DataTables Api instance
      */
-    off(event: string, selector: string, callback?: (this: HTMLElement, e: Event, ...args: any[]) => void): Api<T>;
+    off(event: string, selector: string, callback?: (this: HTMLElement, e: DataTableEvent, ...args: any[]) => void): Api<T>;
     /**
      * Table events listener.
      *
@@ -3442,7 +3450,7 @@ interface ApiScopeable<T, S> {
      * @param callback Event handler.
      * @returns DataTables Api instance
      */
-    on(event: string, callback: (this: HTMLElement, e: Event, ...args: any[]) => void): Api<T>;
+    on(event: string, callback: (this: HTMLElement, e: DataTableEvent, ...args: any[]) => void): Api<T>;
     /**
      * Listen for events from selected elements
      *
@@ -3451,7 +3459,7 @@ interface ApiScopeable<T, S> {
      * @param callback Event handler.
      * @returns DataTables Api instance
      */
-    on(event: string, selector: string, callback: (this: HTMLElement, e: Event, ...args: any[]) => void): Api<T>;
+    on(event: string, selector: string, callback: (this: HTMLElement, e: DataTableEvent, ...args: any[]) => void): Api<T>;
     /**
      * Listen for a table event once and then remove the listener.
      *
@@ -3460,7 +3468,7 @@ interface ApiScopeable<T, S> {
      * Listen for events from tables and fire a callback when they occur
      * @returns DataTables Api instance
      */
-    one(event: string, callback: (this: HTMLElement, e: Event, ...args: any[]) => void): Api<T>;
+    one(event: string, callback: (this: HTMLElement, e: DataTableEvent, ...args: any[]) => void): Api<T>;
     /**
      * Listen for events from a selected element and trigger only once then
      * remove the listener.
@@ -3470,7 +3478,7 @@ interface ApiScopeable<T, S> {
      * @param callback Event handler.
      * @returns DataTables Api instance
      */
-    one(event: string, selector: string, callback: (this: HTMLElement, e: Event, ...args: any[]) => void): Api<T>;
+    one(event: string, selector: string, callback: (this: HTMLElement, e: DataTableEvent, ...args: any[]) => void): Api<T>;
     /**
      * Order Methods / object
      */
@@ -3506,6 +3514,7 @@ interface ApiScopeable<T, S> {
      * Add one or more items to the end of an API instance's result set.
      *
      * @param value_1 Item to add to the API instance's result set.
+     * @param value_2 Additional items to add.
      * @returns The length of the modified API instance
      */
     push(value_1: any, ...value_2: any[]): number;
@@ -3521,7 +3530,7 @@ interface ApiScopeable<T, S> {
      */
     ready(this: S, fn: (this: Api<T>) => void): Api<T>;
     /**
-     * Apply a callback function against and accumulator and each element in the
+     * Apply a callback function against an accumulator and each element in the
      * Api's result set (left-to-right).
      *
      * @param fn Callback function which is called for each item in the API
@@ -3606,6 +3615,7 @@ interface ApiScopeable<T, S> {
      * @param howMany Number of elements to remove from the result set.
      * @param value_1 Item to add to the result set at the index specified by
      * the first parameter.
+     * @param value_2 Additional items to add.
      * @returns An array of the items which were removed. If no elements were
      * removed, an empty array is returned.
      */
@@ -3682,6 +3692,7 @@ interface ApiScopeable<T, S> {
      * Add one or more items to the start of an API instance's result set.
      *
      * @param value_1 Item to add to the API instance's result set.
+     * @param value_2 Additional items to add.
      * @returns The length of the modified API instance
      */
     unshift(value_1: any, ...value_2: any[]): number;
@@ -3695,7 +3706,7 @@ interface ApiCaption {
      * Set the contents of the `-tag caption` element. If the table doesn't have
      * a `-tag caption` element, one will be created automatically.
      *
-     * @param string The value to show in the table's `caption` tag.
+     * @param set The value to show in the table's `caption` tag.
      * @param side `top` or `bottom` to set where the table will be shown on the
      *   table. If not given the previous value will be used (can also be set in
      *   CSS).
@@ -4397,7 +4408,7 @@ interface ApiColumnSearch<T> {
      * Set the search term for the matched column.
      *
      * @param input Search to apply.
-     * @param Search Search configuration options
+     * @param options Search configuration options
      * @returns DataTables API instance
      */
     (input: SearchInput<T>, options: Partial<SearchOptions>): Api<any>;
@@ -4619,7 +4630,7 @@ interface ApiColumnsSearch<T> {
      * Set the search term for the matched columns.
      *
      * @param input Search to apply.
-     * @param Search Search configuration options
+     * @param options Search configuration options
      * @returns DataTables API instance
      */
     (input: SearchInput<T>, options: Partial<SearchOptions>): Api<any>;
@@ -4655,26 +4666,20 @@ interface ApiRowChildMethods<T> {
      * result set, or undefined if there are no child rows set for the parent
      * yet.
      */
-    (): JQuery;
-    /**
-     * Get the child row(s) that have been set for a parent row
-     *
-     * @param showRemove This parameter can be given as true or false
-     * @returns DataTables Api instance.
-     */
-    (showRemove: boolean): RowChildMethods<T>;
+    (): Dom;
     /**
      * Set the data to show in the child row(s). Note that calling this method
      * will replace any child rows which are already attached to the parent row.
      *
      * @param data The data to be shown in the child row can be given in
-     * multiple different ways.
+     * multiple different ways. Can be set to boolean `false` to hide an
+     * existing child row, or boolean `true` to show an existing child row.
      * @param className Class name that is added to the td cell node(s) of the
      * child row(s). As of 1.10.1 it is also added to the tr row node of the
      * child row(s).
      * @returns DataTables Api instance
      */
-    (data: (string | Node | JQuery) | Array<string | number | JQuery>, className?: string): RowChildMethods<T>;
+    (data: (boolean | string | Node | JQuery) | Array<string | number | JQuery>, className?: string): RowChildMethods<T>;
     /**
      * Hide the child row(s) of a parent row
      *
@@ -5114,7 +5119,7 @@ interface DataTablesStatic {
     /**
      * Get all DataTable tables that have been initialised - as HTML elements
      *
-     * @param options Indicate if you want all tables on the page should be
+     * @param visible Indicate if you want all tables on the page should be
      * returned (false), or visible tables only (true).
      * @returns Array of HTML table Elements
      */
@@ -5199,7 +5204,6 @@ interface DataTablesStaticRender {
      * Format an ISO8061 date value using the specified format
      * @param to Display format
      * @param locale Locale
-     * @param def Default value if empty
      */
     date(to: string, locale?: string): DateTimeRenderer;
     /**
@@ -5218,7 +5222,6 @@ interface DataTablesStaticRender {
      * Format an ISO8061 datetime value using the specified format
      * @param to Display format
      * @param locale Locale
-     * @param def Default value if empty
      */
     datetime(to: string, locale?: string): DateTimeRenderer;
     /**
@@ -5256,7 +5259,6 @@ interface DataTablesStaticRender {
      * Format an ISO8061 time value using the specified format
      * @param to Display format
      * @param locale Locale
-     * @param def Default value if empty
      */
     time(to: string, locale?: string): DateTimeRenderer;
     /**
@@ -5340,4 +5342,4 @@ interface DataTable extends DataTablesStatic {}
 declare const DataTable: typeof DataTable$1;
 
 export { Api, Settings as ColumnContext, DataTable, Dom, DataTable as default, _default as util };
-export type { AjaxMethods, AjaxOptions, ApiAjax, ApiCaption, ApiCell, ApiCellMethods, ApiCells, ApiCellsMethods, ApiColumn, ApiColumnMethods, ApiColumnSearch, ApiColumns, ApiColumnsMethods, ApiColumnsSearch, ApiConstructor, ApiOrder, ApiPage, ApiPageInfo, ApiRow, ApiRowChildMethods, ApiRowMethods, ApiRows, ApiRowsMethods, ApiScopeable, ApiSearch, ApiSelector, ApiState, ApiStatic, ApiStaticRegisterFn, ApiTableFooterMethods, ApiTableHeaderMethods, ApiTableMethods, ApiTablesMethods, CellIdx, CellIdxWithVisible, CellSelector, ColumnIdx, ColumnSelector, Options$1 as ColumnsConfig, Context, DataTablesStatic, DataTablesStaticExtButtons, DataTablesStaticRender, Defaults, DomSelector, Ext, ExtButtons, ExtTypeSettings, HeaderStructure, IColumnControlContent, InstSelector, ConfigLanguage as Language, Options, RowChildMethods, Row as RowContext, RowIdx, RowSelector, SelectorModifier, Context as Settings, State, StateLoad, TableSelector };
+export type { AjaxMethods, AjaxOptions, ApiAjax, ApiCaption, ApiCell, ApiCellMethods, ApiCells, ApiCellsMethods, ApiColumn, ApiColumnMethods, ApiColumnSearch, ApiColumns, ApiColumnsMethods, ApiColumnsSearch, ApiConstructor, ApiOrder, ApiPage, ApiPageInfo, ApiRow, ApiRowChildMethods, ApiRowMethods, ApiRows, ApiRowsMethods, ApiScopeable, ApiSearch, ApiSelector, ApiState, ApiStatic, ApiStaticRegisterFn, ApiTableFooterMethods, ApiTableHeaderMethods, ApiTableMethods, ApiTablesMethods, CellIdx, CellIdxWithVisible, CellMeta, CellSelector, ColumnIdx, ColumnRenderFunction, ColumnSelector, Options$1 as ColumnsConfig, Context, DataTableEvent, DataTablesStatic, DataTablesStaticExtButtons, DataTablesStaticRender, DataType, DataTypeDetect, Defaults, DomSelector, Ext, ExtButtons, ExtTypeSettings, HeaderStructure, IColumnControlContent, InstSelector, ConfigLanguage as Language, Options, RowChildMethods, Row as RowContext, RowIdx, RowSelector, SelectorModifier, Context as Settings, State, StateLoad, TableSelector };