Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

plantuml-encoder

markushedvall180kMIT1.4.0TypeScript support: definitely-typed

PlantUML encoder for browsers and Node.js

plantuml, encoder

readme

plantuml-encoder

PlantUML encoder for browsers and Node.js.

npm Version build-status js-standard-style

Encoded PlantUML can be used to create PlantUML URL links.

Install

Node.js:

npm install plantuml-encoder

browser:

bower install plantuml-encoder

Example

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

Decode example

var plantumlEncoder = require('plantuml-encoder')

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

License

MIT