# plantuml-encoder

> PlantUML encoder for browsers and Node.js

Latest version **1.4.0** (published 2019-08-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install plantuml-encoder
pnpm add plantuml-encoder
yarn add plantuml-encoder
bun add plantuml-encoder
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2019-08-09 |
| First published | 2015-06-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/plantuml-encoder) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 292 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 116 |
| Author | Markus Hedvall |
| Maintainers | markushedvall |
| Keywords | plantuml, encoder |

## Links

- npm: https://www.npmjs.com/package/plantuml-encoder
- Repository: https://github.com/markushedvall/plantuml-encoder
- Homepage: https://github.com/markushedvall/plantuml-encoder#readme
- Issues: https://github.com/markushedvall/plantuml-encoder/issues
- npm.io page: https://npm.io/package/plantuml-encoder

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 1.4.0 (latest) — 2019-08-09
- 1.3.0 — 2019-08-08
- 1.2.6 — 2019-08-07
- 1.2.5 — 2018-01-12
- 1.2.4 — 2016-09-24
- 1.2.3 — 2016-01-06
- 1.2.2 — 2015-10-20
- 1.2.1 — 2015-07-27
- 1.2.0 — 2015-07-27
- 1.1.0 — 2015-06-30
- 1.0.2 — 2015-06-26

## README

# plantuml-encoder
PlantUML encoder for browsers and Node.js.

[![npm Version](https://img.shields.io/npm/v/plantuml-encoder.svg)](https://www.npmjs.com/package/plantuml-encoder) [![build-status](https://travis-ci.org/markushedvall/plantuml-encoder.svg?branch=master)](https://travis-ci.org/markushedvall/plantuml-encoder) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)

Encoded PlantUML can be used to create PlantUML URL links.

# Install

Node.js:

```
npm install plantuml-encoder
```

browser:

```
bower install plantuml-encoder
```

# Example

```javascript
var plantumlEncoder = require('plantuml-encoder')

var encoded = plantumlEncoder.encode('A -> B: Hello')
console.log(encoded) // SrJGjLDmibBmICt9oGS0

var url = 'http://www.plantuml.com/plantuml/img/' + encoded
```

The URL can then be used to display the diagram:

![alt tag](http://www.plantuml.com/plantuml/img/SrJGjLDmibBmICt9oGS0)

# Decode example

```javascript
var plantumlEncoder = require('plantuml-encoder')

var plain = plantumlEncoder.decode('SrJGjLDmibBmICt9oGS0')
console.log(plain) // A -> B: Hello

```

# License
MIT

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