# xxtea

> xxtea encryption algorithm in pure javascript

Latest version **0.2.3** (published 2021-09-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install xxtea
pnpm add xxtea
yarn add xxtea
bun add xxtea
```

## 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.2.3 |
| Published | 2021-09-19 |
| First published | 2014-01-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Author | Eugene Shershen |
| Maintainers | h0rn3t, gpedro |
| Keywords | encription, crypt, xxtea, tea, xtea |

## Links

- npm: https://www.npmjs.com/package/xxtea
- Repository: https://github.com/h0rn3t/xxtea
- Homepage: https://github.com/h0rn3t/xxtea.git
- Issues: https://github.com/h0rn3t/xxtea/issues
- npm.io page: https://npm.io/package/xxtea

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 0.2.3 (latest) — 2021-09-19
- 0.2.2 — 2020-06-23
- 0.2.1 — 2018-09-10
- 0.2.0 — 2017-04-06
- 0.1.1 — 2015-12-02
- 0.1.0 — 2014-01-17
- 0.1.3 — 2014-01-17
- 0.1.2 — 2014-01-17
- 0.0.3 — 2014-01-17
- 0.0.2 — 2014-01-17
- 0.0.1 — 2014-01-17

## README

# xxtea

[![npm download](https://img.shields.io/npm/dm/xxtea.svg)](https://www.npmjs.com/package/xxtea)
[![npm version](https://img.shields.io/npm/v/xxtea.svg)](https://www.npmjs.com/package/xxtea)
[![License](https://img.shields.io/npm/l/xxtea-node.svg)](http://opensource.org/licenses/MIT)


Pure javascript xxtea encryption algorithm for Node.js.

## Install

```bash
  npm install xxtea
```

## Usage

```javascript
var xxtea = require('xxtea');
var pass  = 'password';
// to encrypt
var encrypted = xxtea.encrypt('data to encrypt', pass);

// to decrypt
var decrypted = xxtea.decrypt(encrypted, pass);
```

## API

`xxtea`

* `decrypt(string, password)`
  * string - required - the data to be decrypted.
  * password - required - the password to be used in decryption.
* `encrypt(string, password)`
  * string - required - the data to be encrypted.
  * password - required - the password to be used in encryption.

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