Call the WebSequenceDiagram.com API.
JavaScript
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
test
.editorconfig
.eslintrc.js
.gitignore
.travis.yml
README.md
example.wsd
package-lock.json
package.json

README.md

Call the WebSequenceDiagram.com API.

Command Line

wsd_get [options] [input file...]
	
Options:
    -h, --help    Show help
    -f, --format  Format for output (one of [png, pdf, svg]) [default: "png"]
    -o, --output  Output file (defaults to wsd.[png, pdf, svg])
    -s, --style   Output style (one of: [default, earth, modern-blue, mscgen,
                  omegapple, qsd, rose, roundgreen, napkin])

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

Build Status Coverage Status