# @types/objects-to-csv

> TypeScript definitions for objects-to-csv

Latest version **1.3.3** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/objects-to-csv
pnpm add @types/objects-to-csv
yarn add @types/objects-to-csv
bun add @types/objects-to-csv
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.3.3 |
| Published | 2023-11-07 |
| First published | 2020-07-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51419 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/objects-to-csv
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/objects-to-csv
- npm.io page: https://npm.io/package/@types/objects-to-csv

## Recent versions

- 1.3.3 (latest) — 2023-11-07
- 1.3.1 (ts3.6) — 2021-07-08
- 1.3.0 (ts3.0) — 2020-07-10
- 1.3.2 — 2023-10-18

## README

# Installation
> `npm install --save @types/objects-to-csv`

# Summary
This package contains type definitions for objects-to-csv (https://github.com/anton-bot/objects-to-csv#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/objects-to-csv.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/objects-to-csv/index.d.ts)
````ts
declare class ObjectsToCsv {
    /**
     * Creates a new instance of the object array to csv converter.
     */
    constructor(data: object[]);

    /**
     * Holds data to be converted.
     */
    data: object[];

    /**
     * Saves the CSV file to the specified file.
     * @param filename The path and filename of the new CSV file.
     * @param options The options for writing to disk.
     * @param options.append Whether to append to file. Default is overwrite (false).
     * @param options.bom Append the BOM mark so that Excel shows
     * @param options.allColumns Whether to check all items for column names or only the first.  Default is the first.
     * @returns Data converted to a CSV string.
     */
    toDisk(
        filename: string,
        options?: {
            append?: boolean | undefined;
            bom?: boolean | undefined;
            allColumns?: boolean | undefined;
        },
    ): Promise<string>;

    /**
     * Returns the CSV file as string.
     * @param header - If false, omit the first row containing the
     * column names.
     * @param allColumns - Whether to check all items for column names.
     *   Uses only the first item if false.
     */
    toString(header?: boolean, allColumns?: boolean): Promise<string>;

    /**
     * Private method to run the actual conversion of array of objects to CSV data.
     * @param data Data to be converted.
     * @param header Whether the first line should contain column headers.
     * @param allColumns Whether to check all items for column names.
     *   Uses only the first item if false.
     * @returns Data converted to a CSV string.
     */
    convert(data: object[], header?: boolean, allColumns?: boolean): Promise<string>;
}

export = ObjectsToCsv;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: none

# Credits
These definitions were written by [Tom Plant](https://github.com/pl4nty).

---
_Source: https://npm.io/package/@types/objects-to-csv · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._