# @aarongray.org/xlsx-workbook

> XLSXWorkbook class

Latest version **0.0.1** (published 2020-04-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @aarongray.org/xlsx-workbook
pnpm add @aarongray.org/xlsx-workbook
yarn add @aarongray.org/xlsx-workbook
bun add @aarongray.org/xlsx-workbook
```

## 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.0.1 |
| Published | 2020-04-02 |
| First published | 2020-04-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.3 KB |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| Author | AaronNGray |
| Maintainers | aarongray.org |

## Links

- npm: https://www.npmjs.com/package/@aarongray.org/xlsx-workbook
- npm.io page: https://npm.io/package/@aarongray.org/xlsx-workbook

## Dependencies (1)

- [xlsx](https://npm.io/package/xlsx.md) ^0.15.6

## Recent versions

- 0.0.1 (latest) — 2020-04-02

## README

# xlsx-workbook class

A wrapper based on https://github.com/SheetJS/sheetjs

## install

```
npm install --save xlsx-workbook
```

## Usage

```
const XLSXWorkbook = require("xlsx-workbook");

var wb = new XLSXWorkbook();

var spreadsheets = wb.getSpreadsheets
```
## API

```
class XLSXWorkbook

    constructor(Buffer|URL|String) throws "XlsxWorkbook.constructor: bad input type";

    loadWorkbookFromBuffer(Buffer)

    loadWorkbookFromURL(URL)

    loadWorkbookFromFile(String)

    getSpreadsheetNames():String[]

    getSpreadsheetAsObject(name:String)
    getWorkbookAsObject():Object

    getWorkbook()

    saveWorkbookToFile(filename:String|Buffer|URL|Integer)
```

## Example

### test.js
[test.js](https://github.com/AaronNGray/xlsx-workbook/blob/master/test.js) An example based on need.

```
const XLSXWorkbook = require("./index.js");

const dataURL = new URL("https://fingertips.phe.org.uk/documents/Historic%20COVID-19%20Dashboard%20Data.xlsx");

var workbook = new XLSXWorkbook(dataURL);

var data = workbook.getWorkbookAsObject();

console.log(JSON.stringify(data, 2, 2));

workbook.saveWorkbookToFile(filename);
```

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