# egg-xlsx

> read the excel file content plugin for egg framework, based on js-xlsx

Latest version **0.1.1** (published 2018-02-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install egg-xlsx
pnpm add egg-xlsx
yarn add egg-xlsx
bun add egg-xlsx
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2018-02-27 |
| First published | 2018-02-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 3 |
| Unpacked size | 10.5 KB |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| Author | Raoul1996 |
| Maintainers | raoul1996 |
| Keywords | egg, eggPlugin, egg-plugin |

## Links

- npm: https://www.npmjs.com/package/egg-xlsx
- Repository: https://github.com/Raoul1996/egg-xlsx
- Homepage: https://github.com/Raoul1996/egg-xlsx#readme
- Issues: https://github.com/Raoul1996/egg-xlsx/issues
- npm.io page: https://npm.io/package/egg-xlsx

## Dependencies (3)

- [xlsx](https://npm.io/package/xlsx.md) ^0.12.2
- [printj](https://npm.io/package/printj.md) ^1.1.2
- [formidable](https://npm.io/package/formidable.md) ^1.1.1

## Recent versions

- 0.1.1 (latest) — 2018-02-27
- 0.1.0 — 2018-02-27
- 0.0.4 — 2018-02-27
- 0.0.3 — 2018-02-27
- 0.0.2 — 2018-02-27
- 0.0.1 — 2018-02-27

## README

# egg-xlsx

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-xlsx.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-xlsx
[travis-image]: https://img.shields.io/travis/eggjs/egg-xlsx.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-xlsx
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-xlsx.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-xlsx?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-xlsx.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-xlsx
[snyk-image]: https://snyk.io/test/npm/egg-xlsx/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-xlsx
[download-image]: https://img.shields.io/npm/dm/egg-xlsx.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-xlsx

> read the excel file content plugin for egg framework, based on [js-xlsx](https://github.com/SheetJS/js-xlsx)

## Install

```bash
$ npm i egg-xlsx --save
```

## Usage

```js
// {app_root}/config/plugin.js
exports.xlsx = {
  enable: true,
  package: 'egg-xlsx',
};
```

## Configuration

```js
// {app_root}/config/config.default.js
exports.xlsx = {
};
```

see [config/config.default.js](config/config.default.js) for more detail.

## Example

### Upload the xlsx file and get the content

```js
// {app_root}/app/controller/xlsx.js
const Contrller = require('egg').Controller

class XlsxController extends Contrller {
  async index() {
    const {ctx, app} = this
    const res = await app.xlsx.analysis(ctx)
    ctx.body = res
  }
}
module.exports = XlsxController
```
### More function
<!-- example here -->

## Questions & Suggestions

Please open an issue [here](https://github.com/eggjs/egg/issues).

## License

[MIT](LICENSE)

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