# web-scraper-sdk

> This library written in Typescript to take snapshots for microsoft share points

Latest version **1.0.1** (published 2021-09-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install web-scraper-sdk
pnpm add web-scraper-sdk
yarn add web-scraper-sdk
bun add web-scraper-sdk
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-09-17 |
| First published | 2021-09-17 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 136 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Abdulrahman Falyoun |
| Maintainers | abdulrahman-falyoun |

## Links

- npm: https://www.npmjs.com/package/web-scraper-sdk
- Repository: https://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@github.com/lynx-falyoun/web-scraper-sdk
- Homepage: https://github.com/lynx-falyoun/web-scraper-sdk#readme
- Issues: https://github.com/lynx-falyoun/web-scraper-sdk/issues
- npm.io page: https://npm.io/package/web-scraper-sdk

## Dependencies (8)

- [dotenv](https://npm.io/package/dotenv.md) ^10.0.0
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.2
- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.10
- [tscpaths](https://npm.io/package/tscpaths.md) ^0.0.9
- [puppeteer](https://npm.io/package/puppeteer.md) ^10.2.0
- [typescript](https://npm.io/package/typescript.md) ^4.4.3
- [puppeteer-core](https://npm.io/package/puppeteer-core.md) ^10.2.0
- [node-sp-auth-config](https://npm.io/package/node-sp-auth-config.md) ^3.0.1

## Recent versions

- 1.0.1 (latest) — 2021-09-17
- 1.0.0 — 2021-09-17

## README

### Web Scraper SDK
This library written in Typescript to take snapshots for microsoft share points 

#### Installing

> npm i web-scraper-sdk

or

> yarn add web-scraper-sdk

#### Usage

```
const webScraperSdk = require('web-scaper-sdk');
webScraperSdk.scrape({
    removeJS: true,
    snapshot: true,
    website: 'wiki',
    headless: false
})
```

Where `ScrapeOptions` are:

* removeJS: which means remove all <script> tags from share point.

* snapshot: create a new snapshot, if passed false it will look for an already downloaded snapshot in your project dir

* website: that's either of these websites
   
   1- <a href='https://shortpointdev.sharepoint.com/sites/Boilerplate/SitePages/Wiki.aspx' target='_blank'>wiki</a>
   
   2- <a href='https://shortpointdev.sharepoint.com/sites/Boilerplate/SitePages/Blank.aspx' target='_blank'>blank</a>
   
   3- <a href='https://shortpointdev.sharepoint.com/sites/BoilerplateCommunication/SitePages/Blank.aspx' target='_blank'>communication</a>
   
   4- <a href='https://shortpointdev.sharepoint.com/sites/LockdownCommunication/SitePages/Modern.aspx' target='_blank'>modern</a>
 

* headless: chromium mode to open

* executablePath: chromium .exe path

* configPath: generated config file, if don't provide it, it will ask you to supply your credentials via command line

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