Update type defs

risenW · risenW · commit ef3a3b4ba3be · 2022-01-04T12:03:26.000+01:00
diff --git a/src/danfojs-base/core/frame.ts b/src/danfojs-base/core/frame.ts
@@ -12,7 +12,12 @@
 * limitations under the License.
 * ==========================================================================
 */
-import { ArrayType1D, ArrayType2D, DataFrameInterface, BaseDataOptionType } from "../shared/types";
+import {
+    ArrayType1D,
+    ArrayType2D,
+    DataFrameInterface,
+    BaseDataOptionType
+} from "../shared/types";
 import dummyEncode from "../transformers/encoders/dummy.encoder"
 import { variance, std, median, mode, mean } from 'mathjs';
 import { DATA_TYPES } from '../shared/defaults'
@@ -38,7 +43,6 @@ const utils = new Utils();
  * @param options.dtypes Array of data types for each the column. If not specified, dtypes are/is inferred.
  * @param options.config General configuration object for extending or setting NDframe behavior.      
  */
-/* @ts-ignore */ //COMMENT OUT WHEN METHODS HAVE BEEN IMPLEMENTED
 export default class DataFrame extends NDframe implements DataFrameInterface {
     [key: string]: any
     constructor(data: any, options: BaseDataOptionType = {}) {
@@ -1376,7 +1380,7 @@ export default class DataFrame extends NDframe implements DataFrameInterface {
             } else {
                 let columns = [...this.columns]
                 columns.splice(atIndex, 0, column)
-                
+
                 const df = new DataFrame(newData, {
                     index: [...this.index],
                     columns: columns,
diff --git a/src/danfojs-base/core/series.ts b/src/danfojs-base/core/series.ts
@@ -86,7 +86,7 @@ export default class Series extends NDframe implements SeriesInterface {
     * ``.iloc`` will raise ``IndexError`` if a requested indexer is
     * out-of-bounds.
     */
-    iloc(rows: Array<string | number | boolean>) {
+    iloc(rows: Array<string | number | boolean>): Series {
         return _iloc({ ndFrame: this, rows }) as Series
     }
 
@@ -111,7 +111,7 @@ export default class Series extends NDframe implements SeriesInterface {
      * - A ``callable`` function with one argument (the calling Series or
      * DataFrame) and that returns valid output for indexing (one of the above)
     */
-    loc(rows: Array<string | number | boolean>) {
+    loc(rows: Array<string | number | boolean>): Series {
         return _loc({ ndFrame: this, rows }) as Series
     }
 
diff --git a/src/danfojs-browser/src/types.ts b/src/danfojs-browser/src/types.ts
@@ -1,6 +1,24 @@
-import { ParseConfig } from 'papaparse';
-import { Config, Layout  } from "plotly.js-dist-min"
+/**
+*  @license
+* Copyright 2021, JsData. All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+* ==========================================================================
+*/
 
+/**
+ * This file contains all type definitions unique to danfojs-browser version.
+*/
+
+import { ParseConfig } from 'papaparse';
+import { Config, Layout } from "plotly.js-dist-min"
 
 interface CustomConfig extends Config {
     x: string
diff --git a/src/danfojs-node/src/core/frame.ts b/src/danfojs-node/src/core/frame.ts
@@ -13,7 +13,7 @@
 * ==========================================================================
 */
 import { toCSV, toExcel, toJSON } from "../io";
-import { CsvOutputOptionsNode } from "types";
+import { CsvOutputOptionsNode, ExcelOutputOptionsNode, JsonOutputOptionsNode } from "types";
 import  BaseDataFrame from "../../../danfojs-base/core/frame"
 import { BaseDataOptionType } from "../../../danfojs-base/shared/types";
 
@@ -63,8 +63,8 @@ export default class DataFrame extends BaseDataFrame {
      * }
      * ```
      */
-    toJSON(options?: { format?: "row" | "column", filePath?: string }): object
-    toJSON(options?: { format?: "row" | "column", filePath?: string }): object | void {
+    toJSON(options?: JsonOutputOptionsNode): object
+    toJSON(options?: JsonOutputOptionsNode): object | void {
         return toJSON(this, options);
     }
 
@@ -75,7 +75,7 @@ export default class DataFrame extends BaseDataFrame {
      * - `sheetName`: The sheet name to be written to. Defaults to `'Sheet1'`.
      * - `filePath`: The filePath to be written to. Defaults to `'./output.xlsx'`.
      */
-    toExcel(options?: { filePath?: string, sheetName?: string }): void {
+    toExcel(options?: ExcelOutputOptionsNode): void {
         return toExcel(this, options);
     }
 }
diff --git a/src/danfojs-node/src/types.ts b/src/danfojs-node/src/types.ts
@@ -1,3 +1,5 @@
 import { ParseConfig } from 'papaparse';
 export interface CsvInputOptions extends ParseConfig { }
 export type CsvOutputOptionsNode = { filePath?: string, sep?: string, header?: boolean }
+export type JsonOutputOptionsNode = { format?: "row" | "column", filePath?: string }
+export type ExcelOutputOptionsNode = { filePath?: string, sheetName?: string }
