https://github.com/benjlevesque/gsheet-object

Manipulate your Google Sheets in typescript
https://github.com/benjlevesque/gsheet-object

Last synced: 4 days ago
JSON representation

Manipulate your Google Sheets in typescript

• Host: GitHub
• URL: https://github.com/benjlevesque/gsheet-object
• Owner: benjlevesque
• Created: 2019-11-15T19:14:02.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-26T13:42:59.000Z (10 months ago)
• Last Synced: 2024-06-09T14:05:22.940Z (7 months ago)
• Language: TypeScript
• Homepage:
• Size: 256 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# gsheet-object

## Install

```

yarn add gsheet-object googleapis

```

## Usage

You first need to set an environment variable to your sheet ID: `SPREADSHEET_ID=YOUR SHEET ID`

Let's use a sheet called Cities, with the following data:

| City   | Country Name |

| ------ | ------------ |

| Paris  | France       |

| London | UK           |

```typescript

interface ICity {

  city: string;

  countryName: string;

}

async function demo() {

  const sheet = await GoogleSheet.load("Cities");

  const cities = await sheet.getData();

  const paris = cities[0]; // { city: 'Paris', countryName: 'France', _row: 1 }

  const indexed = await sheet.getIndexed(x => x.city);

  console.log(indexed["Paris"]); // { city: 'Paris', countryName: 'France', _row: 1 }

  const pairs = await sheet.getPairs(

    x => x.city,

    x => x.countryName

  );

  console.log(pairs["Paris"]); // France

  await sheet.append({

    city: "Toulouse",

    countryName: "France",

  });

  // Update line

  await sheet.update(paris, "countryName", "USA");

  // or

  await sheet.update(0, "countryName", "USA");

  await sheet.delete(paris);

}

```