# sheet-loader

> Google Spreadsheet loader wrapper.

Latest version **2.1.6** (published 2024-04-10) · ISC license · 0 weekly downloads

## Install

```sh
npm install sheet-loader
pnpm add sheet-loader
yarn add sheet-loader
bun add sheet-loader
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.1.6 |
| Published | 2024-04-10 |
| First published | 2015-03-30 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 5.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Fujisawa Shin |
| Maintainers | fnobi |

## Links

- npm: https://www.npmjs.com/package/sheet-loader
- Repository: https://github.com/fnobi/sheet-loader
- Issues: https://github.com/fnobi/sheet-loader/issues
- npm.io page: https://npm.io/package/sheet-loader

## Dependencies (4)

- [mz](https://npm.io/package/mz.md) ^2.7.0
- [read](https://npm.io/package/read.md) 1.*
- [lodash](https://npm.io/package/lodash.md) ^4.17.19
- [google-spreadsheet](https://npm.io/package/google-spreadsheet.md) ^4.1.1

## Recent versions

- 2.1.6 (latest) — 2024-04-10
- 2.1.5 — 2022-06-25
- 2.1.4 — 2020-07-16
- 2.1.3 — 2020-03-02
- 2.1.2 — 2020-03-01
- 2.1.1 — 2020-03-01
- 2.1.0 — 2018-07-08
- 2.0.1 — 2018-07-08
- 2.0.0 — 2017-12-24
- 1.1.0 — 2015-11-15
- 1.0.0 — 2015-11-15
- 0.1.2 — 2015-03-30
- 0.1.1 — 2015-03-30
- 0.1.0 — 2015-03-30

## README

sheet-loader
====

Google Spreadsheet loader wrapper.

## install

```
npm install sheet-loader
```

## usage

### initialize

```javascript
const SheetLoader = require('sheet-loader');

const sheetLoader = new SheetLoader({
    sheetKey: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
    keyFilePath: './xxxxxxxx-xxxxxxx.json'
});
```

### load data with column scheme

```javascript
sheetLoader.loadRecords({
    sheetTitle: 'sample sheet',
    columns: {
        name: '名前',
        message: '文章',
        year: '年',
        month: '月',
        date: '日'
    }
}).then((records) => {
    records.forEach(function (row, index) {
        console.log('========================');
        console.log('name:\t' + row.name);
        console.log('birth day:\t' + [row.year, row.month, row.date].join('.');
    });
});
```

### load raw sheet data

```javascript
sheetLoader.loadRows('sample sheet').then((rows) => {
    console.log(rows);
});
```

### export records to json file

```javascript
sheetLoader.exportRecords('./sample.json', {
    sheetTitle: 'sample sheet',
    columns: {
        name: '名前',
        message: '文章',
        year: '年',
        month: '月',
        date: '日'
    }
}).then(() => {
    console.log('done.');
});
```

### auth with raw credentials

```javascript
const sheetLoader = new SheetLoader({
    sheetKey: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
    credentials: {
        client_email: 'xxxxxxxxxxxxxxx@developer.gserviceaccount.com',
        private_key: 'XXXXXXXXXXXXXXX'
    },
});
```

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