# websequencediagrams-ws

> Interface to websequencediagrams.com

Latest version **0.0.3** (published 2017-03-20) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install websequencediagrams-ws
pnpm add websequencediagrams-ws
yarn add websequencediagrams-ws
bun add websequencediagrams-ws
```

Provides the command `wsd_get`.

## 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.0.3 |
| Published | 2017-03-20 |
| First published | 2017-03-20 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Joe Hildebrand |
| Maintainers | mishgul |
| Keywords | uml, sequence diagram, sequence, diagram, websequencediagrams, websequencediagrams.com |

## Links

- npm: https://www.npmjs.com/package/websequencediagrams-ws
- Repository: https://github.com/Onegini/node-websequencediagrams
- Issues: https://github.com/Onegini/node-websequencediagrams/issues
- npm.io page: https://npm.io/package/websequencediagrams-ws

## Dependencies (1)

- [optimist](https://npm.io/package/optimist.md) ~0.3.4

## Recent versions

- 0.0.3 (latest) — 2017-03-20

## README

Call the WebSequenceDiagram.com API.

Example:

    var wsd = require('websequencediagrams');
    var fs = require('fs');
    wsd.diagram("Alice->Bob: message", "modern-blue", "png", function(er, buf, typ) {
    	if (er) {
    		console.error(er);    		
    	} else {
    		console.log("Received MIME type:", typ);
    		fs.writeFile("my.png", buf);
    	}
    });

### .diagram(text, style, output_type, callback)
Takes the text to turn into a diagram, the style name, the output type, and a callback.

Valid output types include "png", "svg", and "pdf".

The callback takes an error, a Buffer, and a MIME type

### .styles
.styles is an array of all of the currently-known style types.

### .root
.root is the URL for the service, which defaults to "http://www.websequencediagrams.com".  It can be modified to suit your needs.

### License
This code is licensed under the [Apache Software License, 2.0](http://www.apache.org/licenses/LICENSE-2.0)

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