Interface IAsyncFileReader

Reads a file asynchonrously to a dataframe.

Hierarchy

IAsyncFileReader

Index

Methods

Methods

parseCSV

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

- Defined in index.ts:445
Deserialize a CSV file to a DataFrame. Returns a promise that later resolves to a DataFrame.
example
```
const df = await dataForge.readFile("my-data-file.csv").parseCSV();
```
example
```
const options = {
     // ...
};
const df = await dataForge.readFile("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 Promise<IDataFrame<number, any>>

Returns a promise of a dataframe loaded from the file.

parseJSON

parseJSON(): Promise<IDataFrame<number, any>>

- Defined in index.ts:459
Deserialize a JSON file to a DataFrame. Returns a promise that later resolves to a DataFrame.
example
```
const df = await dataForge.readFile("my-data-file.json").parseJSON();
```
Returns Promise<IDataFrame<number, any>>

Returns a promise of a dataframe loaded from the file.

Generated using TypeDoc