danfojs
Version:
JavaScript library providing high performance, intuitive, and easy to use data structures for manipulating and processing structured data.
89 lines (87 loc) • 3.59 kB
TypeScript
/**
* @license
* Copyright 2022 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.
* ==========================================================================
*/
import { CsvInputOptionsBrowser, CsvOutputOptionsBrowser } from "../../shared/types";
import { DataFrame, NDframe, Series } from '../../';
/**
* Reads a CSV file from local or remote location into a DataFrame.
* @param filePath URL or local file path to CSV file. `readCSV` uses PapaParse to parse the CSV file,
* hence all PapaParse options are supported.
* @param options Configuration object. Supports all Papaparse parse config options.
* @returns DataFrame containing the parsed CSV file.
* @throws {Error} If file cannot be read or parsed
* @example
* ```
* import { readCSV } from "danfojs-node"
* const df = await readCSV("https://raw.githubusercontent.com/test.csv")
* ```
* @example
* ```
* import { readCSV } from "danfojs-node"
* const df = await readCSV("https://raw.githubusercontent.com/test.csv", {
* delimiter: ",",
* headers: {
* Accept: "text/csv",
* Authorization: "Bearer YWRtaW46YWRtaW4="
* }
* })
* ```
* @example
* ```
* import { readCSV } from "danfojs-node"
* const df = await readCSV("./data/sample.csv")
* ```
*/
declare const $readCSV: (file: any, options?: CsvInputOptionsBrowser | undefined) => Promise<DataFrame>;
/**
* Streams a CSV file from local or remote location in chunks. Intermediate chunks is passed as a DataFrame to the callback function.
* @param filePath URL or local file path to CSV file. `readCSV` uses PapaParse to parse the CSV file,
* hence all PapaParse options are supported.
* @param options Configuration object. Supports all Papaparse parse config options.
* @param callback Callback function to be called once the specifed rows are parsed into DataFrame.
* @example
* ```
* import { streamCSV } from "danfojs-node"
* streamCSV("https://raw.githubusercontent.com/test.csv", (dfRow) => {
* const dfModified = dfRow["Names"].map((name) => name.split(",")[0])
* return dfModified
* })
* ```
*/
declare const $streamCSV: (file: string, callback: (df: DataFrame) => void, options: CsvInputOptionsBrowser) => Promise<null>;
/**
* Converts a DataFrame or Series to CSV.
* @param df DataFrame or Series to be converted to CSV.
* @param options Configuration object. Supports the following options:
* - `filePath`: Local file path to write the CSV file. If not specified, the CSV will be returned as a string.
* - `header`: Boolean indicating whether to include a header row in the CSV file.
* - `sep`: Character to be used as a separator in the CSV file.
* @example
* ```
* import { toCSV } from "danfojs-node"
* const df = new DataFrame([[1, 2, 3], [4, 5, 6]])
* const csv = toCSV(df)
* ```
* @example
* ```
* import { toCSV } from "danfojs-node"
* const df = new DataFrame([[1, 2, 3], [4, 5, 6]])
* toCSV(df, {
* filePath: "./data/sample.csv",
* header: true,
* sep: "+"
* })
* ```
*/
declare const $toCSV: (df: NDframe | DataFrame | Series, options?: CsvOutputOptionsBrowser | undefined) => string | void;
export { $readCSV, $streamCSV, $toCSV, };