# gulp-xlsx2json

> Excel (XLSX/XLS) to json

Latest version **1.0.5** (published 2019-04-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-xlsx2json
pnpm add gulp-xlsx2json
yarn add gulp-xlsx2json
bun add gulp-xlsx2json
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2019-04-19 |
| First published | 2019-04-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | chris |
| Maintainers | ryantech |
| Keywords | gulp, gulpplugin, excel |

## Links

- npm: https://www.npmjs.com/package/gulp-xlsx2json
- Repository: https://github.com/csxrzeng/gulp-xlsx2json
- Homepage: https://github.com/csxrzeng/gulp-xlsx2json#readme
- Issues: https://github.com/csxrzeng/gulp-xlsx2json/issues
- npm.io page: https://npm.io/package/gulp-xlsx2json

## Dependencies (3)

- [xlsx](https://npm.io/package/xlsx.md) ^0.8.0
- [through2](https://npm.io/package/through2.md) ^2.0.0
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.7

## Recent versions

- 1.0.5 (latest) — 2019-04-19

## README

# gulp-xlsx2json
> Excel (XLSX/XLS) to json.
> If there is a headRow specified, export each line to an object.
> Otherwise export each line to an array.

## Usage
First, install `gulp-xlsx2json` as a development dependency:

```shell
> npm install --save-dev gulp-xlsx2json
```

Then, add it to your `gulpfile.js`:

```javascript
var xlsx2json = require('gulp-xlsx2json');

gulp.task('copy', function() {
    gulp.src('config/**.xlsx')
        .pipe(xlsx2json({
            headRow: 1,
            valueRowStart: 3,
            trace: true
        }))
        .pipe(gulp.dest('build'))
});
```


## API

### xlsx2json([options])

#### options.headRow
Type: `number`

Default: `1`

The row number of head. (Start from 1).

#### options.valueRowStart
Type: `number`

Default: `3`

The start row number of values. (Start from 1)

#### options.trace
Type: `Boolean`

Default: `false`

Whether to log each file path while convert success.

## License
MIT © Chris

---
_Source: https://npm.io/package/gulp-xlsx2json · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._