@types/convert-excel-to-json/README.md

TypeScript definitions for convert-excel-to-json

# Installation
> `npm install --save @types/convert-excel-to-json`

# Summary
This package contains type definitions for convert-excel-to-json (https://github.com/DiegoZoracKy/convert-excel-to-json).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/convert-excel-to-json.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/convert-excel-to-json/index.d.ts)
````ts
/// <reference types="node" />

interface SheetConfig {
    header?: { rows: number } | undefined;
    range?: string | undefined;
    columnToKey?: { [key: string]: string } | undefined;
    includeEmptyLines?: boolean | undefined;
    sheetStubs?: boolean | undefined;
}

declare function excelToJson(
    config:
        | ({ sourceFile: string } | { source: string | Buffer }) // Either sourceFile or source should have a value
            & { sheets?: ReadonlyArray<(string | (SheetConfig & { name: string }))> | undefined } // Nested SheetConfig should be allowed
            & SheetConfig // ... or just a simple config for all
        | string, // Input can also be a json-string (for cli)
    sourceFile?: string, // For cli
): { [key: string]: any[] }; // Using any to provide more flexibility for downstream usages

export = excelToJson;

````

### Additional Details
 * Last updated: Mon, 06 Nov 2023 22:41:05 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

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