# protectedtext-api

> Unofficial protectedtext.com API

Latest version **1.0.1** (published 2021-03-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install protectedtext-api
pnpm add protectedtext-api
yarn add protectedtext-api
bun add protectedtext-api
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-03-24 |
| First published | 2021-03-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.4 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Pablo Skubert |
| Maintainers | deeman |
| Keywords | ProtectedText API, Protectedtext, protectedtext-api |

## Links

- npm: https://www.npmjs.com/package/protectedtext-api
- Repository: https://github.com/pabloskubert/protectedtext-api
- Homepage: https://github.com/pabloskubert/protectedtext-api#readme
- Issues: https://github.com/pabloskubert/protectedtext-api/issues
- npm.io page: https://npm.io/package/protectedtext-api

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.21.1
- [crypto-js](https://npm.io/package/crypto-js.md) ^4.0.0

## Recent versions

- 1.0.1 (latest) — 2021-03-24
- 1.0.0 — 2021-03-24

## README

<h1 align="center">Welcome to protectedtext-api 👋</h1>
<p>
  <p align="center">
  <img src="https://ostechnix.com/wp-content/uploads/2018/11/protected-text.png" />
</p>
<img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
<p>
  <a href="https://github.com/pabloskubert/protectedtext-api#readme" target="_blank">
    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
  </a>
  <a href="https://github.com/pabloskubert/protectedtext-api/graphs/commit-activity" target="_blank">
    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
  </a>
  <a href="https://github.com/pabloskubert/protectedtext-api/blob/master/LICENSE" target="_blank">
    <img alt="License: MIT" src="https://img.shields.io/github/license/pabloskubert/protectedtext-api" />
  </a>
  <a href="https://twitter.com/pabloskubert" target="_blank">
    <img alt="Twitter: pabloskubert" src="https://img.shields.io/twitter/follow/pabloskubert.svg?style=social" />
  </a>
</p>

> Unofficial protectedtext.com API

## Install

```sh
npm install protectedtext-api
```

## Usage
```javascript
const ProtectedTextAPI = require('protectedtext-api');

(async function() {
    const site_id = "test";
    const site_password = "123";

    var TabManager = (await new ProtectedTextAPI(site_id, site_password).loadTabs());
    var savedText  = (await TabManager.view());

    // View saved content
    console.log(savedText);

    // Save new content, but keep old text
    await TabManager.save(savedText.concat("IT WORKS!"));
})();
```
## API REFERENCE
<table>
<thead>
  <tr>
    <th>Method</th>
    <th>Params</th>
    <th>Description</th>
    <th>Returns</th>
  </tr>
</thead>
<tbody>
  <tr>
    <td>save</td>
    <td>text: string</td>
    <td>Save the given text, rewriting tab content</td>
    <td>boolean</td>
  </tr>
  <tr>
    <td>view</td>
    <td>void</td>
    <td>Get all tab' s content</td>
    <td>string</td>
  </tr>
  <tr>
    <td>deleteSite</td>
    <td>void</td>
    <td>delete site, with all content, dangerous method.</td>
    <td>boolean</td>
  </tr>
</tbody>
</table>

## Future implementations :rocket:	:rocket:
 - Add tab support
 - Add support for browser
 - Auto register site, if not exists

## Author

👤 **Pablo Skubert <pablo1920@protonmail.com>**

* Twitter: [@pabloskubert](https://twitter.com/pabloskubert)
* Github: [@pabloskubert](https://github.com/pabloskubert)
* LinkedIn: [@pablo-henrique-gomes-580458144](https://linkedin.com/in/pablo-henrique-gomes-580458144)

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2021 [Pablo Skubert <pablo1920@protonmail.com>](https://github.com/pabloskubert).<br />
This project is [MIT](https://github.com/pabloskubert/protectedtext-api/blob/master/LICENSE) licensed.

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