Interface ISyncFileReader

Reads a file synchonrously to a dataframe.

Hierarchy

ISyncFileReader

Index

Methods

Methods

parseCSV

parseCSV(config?: ICSVOptions): IDataFrame<number, any>

- Defined in index.ts:553
Deserialize a CSV file to a DataFrame.
example
```
const df = dataForge.readFileSync("my-data-file.csv").parseCSV();
```
example
```
const options = {
     // ...
};
const df = dataForge.readFileSync("my-data-file.csv").parseCSV(options);
```
Parameters
- Optional config: ICSVOptions
  
  Optional configuration file for parsing. The config object is passed directly to PapaParse.parse, please see PapaParse docs for additional options.
Returns IDataFrame<number, any>

Returns a dataframe that was deserialized from the file.

parseJSON

parseJSON(): IDataFrame<number, any>

- Defined in index.ts:566
Deserialize a JSON file to a DataFrame.
example
```
const df = dataForge.readFileSync("my-data-file.json").parseJSON();
```
Returns IDataFrame<number, any>

Returns a dataframe that was deserialized from the file.

Generated using TypeDoc